com.ibm.maximo.oslc

Class ResourceSet

java.lang.Object

com.ibm.maximo.oslc.ResourceSet

public class ResourceSet
extends Object

ResourceSet implement the operations on ResourceSet. It provides the set of Resource.

This object can be created by MaximoConnector. The following code shows how to create MaximoConnector

 
 ResourceSet rs = mc.resourceSet(osName);
 ResourceSet rs = mc.resourceSet(URL);
 
 

The following examples demonstrate how to build a new ResourceSet

 
 ResourceSet rs = new ResourceSet(osName);
 ResourceSet rs = new ResourceSet(maximoConnector);
 ResourceSet rs = new ResourceSet(osName, maximoConnector);
 ResourceSet rs = new ResourceSet(URL, maximoConnector);
 
 

The following examples show how to set ResourceSet data from ResourceSet

 
 rs.where(queryWhere).select(querySelect).hasTerms(terms).pageSize(pageSize)
 rs.paging();
 rs.stablePageing();
 
 

The following examples show how to fetch, load, reload, go to next page, go back to previous page, get savedQuery for ResourceSet data

 
 rs.fetch(mapOptions);
 rs.load();
 rs.reload();
 rs.nextPage();
 rs.previousPage();
 rs.savedQuery(savedQuery);
 rs.savedQuery(name, paramValues);
 
 

The following examples show how to get ResourceSet data from ResourceSet

 
 JsonObject jo = rs.toJSON(); 
 byte[] jodata = rs.toJSONBytes();
 
 

The following examples show how to create, get and delete Resource from ResourceSet

 
 Resource rs = fetchMember(uri, properties);
 Resource rs = member(index);
 Resource rs = create(jsonObject, properties);
 
 

The following example shows how to get the this page size from ResourceSet

 
 int count = rs.count();
 int totalCount = rs.totalCount();
 int totalCount = rs.totalCount(true);
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger

Constructor Summary

Constructors

Constructor and Description
ResourceSet(MaximoConnector mc)
ResourceSet(String osName)
ResourceSet(String osName, MaximoConnector mc)
ResourceSet(URL publicURI, MaximoConnector mc)

Method Summary

Methods

Modifier and Type	Method and Description
BulkProcessor	bulk()
int	configuredPageSize()
int	count() get current number of Resource by calling RESTful API
Resource	create(javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
Resource	create(javax.json.JsonObject jo, String... properties) Create a new Resource with the properties in hearder
ResourceSet	fetch() Fetching the data for ResourceSet
ResourceSet	fetch(Map options)
Resource	fetchMember(String uri, String... properties)
ResourceSet	fetchWithAddtionalHeaders(Map<String,Object> additionalHeaders) Fetching the data for ResourceSet with arbitrary headers
ResourceSet	fetchWithAddtionalHeadersAndParams(Map<String,Object> additionalParams, Map<String,Object> additionalHeaders) Fetching the data for ResourceSet with arbitrary parameters and headers
ResourceSet	fetchWithAddtionalParams(Map<String,Object> additionalParams) Fetching the data for ResourceSet with arbitrary parameters
String	getAppURI() Get current URI
String	getOsURI()
String	getPublicURI()
Aggregation	groupBy()
boolean	hasNextPage()
ResourceSet	hasTerms(String... terms)
ResourceSet	load() Load the current data
Resource	member(int index) get the member in ResourceSet
Resource	mergeSync(javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
Resource	mergeSync(javax.json.JsonObject jo, String... properties)
ResourceSet	nextPage() Go to nextPage
ResourceSet	orderBy(String... orderByProperties)
ResourceSet	pageSize(int pageSize)
ResourceSet	paging(boolean type)
ResourceSet	previousPage() Go back to previous page
ResourceSet	reload()
ResourceSet	savedQuery(SavedQuery qsaved)
ResourceSet	savedQuery(String name, Map<String,Object> paramValues)
ResourceSet	searchAttributes(String... attributes)
ResourceSet	select(String... selectClause)
ResourceSet	stablePaging(boolean type)
Resource	sync(javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
Resource	sync(javax.json.JsonObject jo, String... properties)
javax.json.JsonObject	toJSON() Get ResourceSet data in JSON
byte[]	toJSONBytes() Get ResourceSet data in JSONBytes
int	totalCount() Count the total number of Resources by calling RESTful API
int	totalCount(boolean fromServer) Count the total number of Resources.
ResourceSet	where(QueryWhere where)
ResourceSet	where(String whereClause)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static final Logger logger

Constructor Detail

ResourceSet

public ResourceSet(String osName)

ResourceSet

public ResourceSet(MaximoConnector mc)

ResourceSet

public ResourceSet(String osName,
           MaximoConnector mc)

ResourceSet

public ResourceSet(URL publicURI,
           MaximoConnector mc)

Method Detail

getAppURI

public String getAppURI()

Get current URI

getPublicURI

public String getPublicURI()

getOsURI

public String getOsURI()

toJSON

public javax.json.JsonObject toJSON()
                             throws IOException,
                                    OslcException

Get ResourceSet data in JSON

Throws:

IOException

OslcException

toJSONBytes

public byte[] toJSONBytes()
                   throws OslcException,
                          IOException

Get ResourceSet data in JSONBytes

Throws:

IOException

OslcException

where

public ResourceSet where(String whereClause)

where

public ResourceSet where(QueryWhere where)

searchAttributes

public ResourceSet searchAttributes(String... attributes)

hasTerms

public ResourceSet hasTerms(String... terms)

select

public ResourceSet select(String... selectClause)

pageSize

public ResourceSet pageSize(int pageSize)

paging

public ResourceSet paging(boolean type)

stablePaging

public ResourceSet stablePaging(boolean type)

orderBy

public ResourceSet orderBy(String... orderByProperties)

fetch

public ResourceSet fetch()
                  throws OslcException,
                         IOException

Fetching the data for ResourceSet

Throws:

OslcException

IOException

fetchWithAddtionalParams

public ResourceSet fetchWithAddtionalParams(Map<String,Object> additionalParams)
                                     throws OslcException,
                                            IOException

Fetching the data for ResourceSet with arbitrary parameters

Parameters:

additionalParams -

Throws:

OslcException

IOException

fetchWithAddtionalHeaders

public ResourceSet fetchWithAddtionalHeaders(Map<String,Object> additionalHeaders)
                                      throws OslcException,
                                             IOException

Fetching the data for ResourceSet with arbitrary headers

Parameters:

additionalHeaders -

Throws:

OslcException

IOException

fetchWithAddtionalHeadersAndParams

public ResourceSet fetchWithAddtionalHeadersAndParams(Map<String,Object> additionalParams,
                                             Map<String,Object> additionalHeaders)
                                               throws OslcException,
                                                      IOException

Fetching the data for ResourceSet with arbitrary parameters and headers

Parameters:

additionalParams -

additionalHeaders -

Throws:

OslcException

IOException

fetch

public ResourceSet fetch(Map options)
                  throws OslcException,
                         IOException

Throws:

OslcException

IOException

nextPage

public ResourceSet nextPage()
                     throws IOException,
                            OslcException

Go to nextPage

Throws:

IOException

OslcException

hasNextPage

public boolean hasNextPage()
                    throws IOException,
                           OslcException

Throws:

IOException

OslcException

previousPage

public ResourceSet previousPage()
                         throws IOException,
                                OslcException

Go back to previous page

Throws:

IOException

OslcException

load

public ResourceSet load()
                 throws OslcException,
                        IOException

Load the current data

Throws:

OslcException

IOException

reload

public ResourceSet reload()
                   throws OslcException,
                          IOException

Throws:

OslcException

IOException

savedQuery

public ResourceSet savedQuery(String name,
                     Map<String,Object> paramValues)

Throws:

DatatypeConfigurationException

UnsupportedEncodingException

savedQuery

public ResourceSet savedQuery(SavedQuery qsaved)

fetchMember

public Resource fetchMember(String uri,
                   String... properties)
                     throws IOException,
                            OslcException

Throws:

IOException

OslcException

member

public Resource member(int index)
                throws OslcException,
                       IOException

get the member in ResourceSet

Parameters:

index -

Throws:

IOException

OslcException

create

public Resource create(javax.json.JsonObject jo,
              String... properties)
                throws IOException,
                       OslcException

Create a new Resource with the properties in hearder

Parameters:

jo -

properties -

Throws:

IOException

OslcException

create

public Resource create(javax.json.JsonObject jo,
              Map<String,Object> headers,
              String... properties)
                throws IOException,
                       OslcException

Throws:

IOException

OslcException

sync

public Resource sync(javax.json.JsonObject jo,
            String... properties)
              throws IOException,
                     OslcException

Throws:

IOException

OslcException

sync

public Resource sync(javax.json.JsonObject jo,
            Map<String,Object> headers,
            String... properties)
              throws IOException,
                     OslcException

Throws:

IOException

OslcException

mergeSync

public Resource mergeSync(javax.json.JsonObject jo,
                 String... properties)
                   throws IOException,
                          OslcException

Throws:

IOException

OslcException

mergeSync

public Resource mergeSync(javax.json.JsonObject jo,
                 Map<String,Object> headers,
                 String... properties)
                   throws IOException,
                          OslcException

Throws:

IOException

OslcException

configuredPageSize

public int configuredPageSize()

totalCount

public int totalCount()
               throws IOException,
                      OslcException

Count the total number of Resources by calling RESTful API

Throws:

IOException

OslcException

totalCount

public int totalCount(boolean fromServer)
               throws IOException,
                      OslcException

Count the total number of Resources. When fromServer=true, it calls the totalCount API. When fromServer=false, it calls the RESTful API.

Throws:

IOException

OslcException

count

public int count()
          throws OslcException,
                 IOException

get current number of Resource by calling RESTful API

Throws:

OslcException

IOException

bulk

public BulkProcessor bulk()

groupBy

public Aggregation groupBy()