com.ibm.maximo.oslc

Class Resource

java.lang.Object

com.ibm.maximo.oslc.Resource

public class Resource
extends Object

Resource implement the operations on Resource. It provides the data, uri, attachment and so on.

This object can be created by ResourceSet or MaximoConnector. The following code shows how to create Resource using ResourceSet or using the MaximoConnector

 
 Resource re = re.member(index);
 Resource re = re.fetchMember(uri,properties);
 Resource re = mc.resource(uri, properties);
 
 

The following examples demonstrate how to build a new Resource

 
 Resource re = new Resource();
 Resource re = new Resource(uri);
 Resource re = new Resource(jsonObject);
 Resource re = new Resource(uri,maximoConnector);
 Resource re = new Resource(jsonObject, maximoConnector);
 
 

The following examples demonstrate how to set uri and maximoConnector to Resource

 
 re.uri(URI).maximoConnector(maximoConnector);
 
 

The following examples show how to load and reload data

 
 re.load();
 re.reload();
 
 

The following examples show how to get information from Resource

 
 
 JsonObject jo = re.toJSON();
 byte[] joBytes = re.toJSONBytes();
 
 

The following examples show how to update, merge and delete the {&code Resource}

 
 re.update(jsonObject,properties);
 re.merge(jsonObject,properties);
 re.delete(index); 
 rs.re.delete(); //if the attachment is deleted as rs.re.detele(), please reload ResourceSet after.
 
 

The following example show how to get attachmentSet, relatedResource and how to invoke action by Resource

 AttachmentSet ats = re.attachmentSet(doclinkAttrName, relName);
 Resource relationRe = re.relatedResource(attrName);
 re.invokeAction(actionName,jsonObeject);
 

Constructor Summary

Constructors

Constructor and Description
Resource(javax.json.JsonObject jo)
Resource(javax.json.JsonObject jo, MaximoConnector mc)
Resource(String href)
Resource(String href, MaximoConnector mc)

Method Summary

Methods

Modifier and Type	Method and Description
AttachmentSet	attachmentSet()
AttachmentSet	attachmentSet(String doclinkAttrName, String relName) Load the attachmentset for resource Note: there has to be a relation between them
void	delete()
String	getURI() Get current URI
Resource	invokeAction(String actionName, javax.json.JsonObject jo) Invoke Action
Resource	invokeAction(String actionName, javax.json.JsonObject jo, String... properties)
Resource	load() Load current data with properties in header
Resource	load(String... properties)
Resource	loadWithAdditionalHeaders(Map<String,Object> headers, String... properties)
Resource	loadWithAdditionalParams(Map<String,Object> params, String... properties)
Resource	loadWithAdditionalParamsAndHeaders(Map<String,Object> params, Map<String,Object> headers, String... properties)
Resource	maximoConnector(MaximoConnector mc)
Resource	merge(javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
Resource	merge(javax.json.JsonObject jo, String... properties)
Resource	relatedResource(String attrName)
Resource	reload()
Resource	reload(String... properties)
void	setLoaded(boolean isLoaded) Support pre-load resource.
javax.json.JsonObject	toJSON() Get Resource data in JSON
byte[]	toJSONBytes() Get Resource data in JSONBytes
Resource	update(javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
Resource	update(javax.json.JsonObject jo, String... properties) Update the Resource
Resource	uri(String href)

Methods inherited from class java.lang.Object

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

Constructor Detail

Resource

public Resource(javax.json.JsonObject jo)

Resource

public Resource(javax.json.JsonObject jo,
        MaximoConnector mc)

Resource

public Resource(String href)

Resource

public Resource(String href,
        MaximoConnector mc)

Method Detail

uri

public Resource uri(String href)

maximoConnector

public Resource maximoConnector(MaximoConnector mc)

getURI

public String getURI()

Get current URI

toJSON

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

Get Resource data in JSON

Throws:

IOException

OslcException

toJSONBytes

public byte[] toJSONBytes()
                   throws OslcException,
                          IOException

Get Resource data in JSONBytes

Throws:

IOException

OslcException

load

public Resource load()
              throws OslcException,
                     IOException

Load current data with properties in header

Throws:

IOException

OslcException

load

public Resource load(String... properties)
              throws OslcException,
                     IOException

Throws:

OslcException

IOException

loadWithAdditionalParams

public Resource loadWithAdditionalParams(Map<String,Object> params,
                                String... properties)
                                  throws OslcException,
                                         IOException

Throws:

OslcException

IOException

loadWithAdditionalHeaders

public Resource loadWithAdditionalHeaders(Map<String,Object> headers,
                                 String... properties)
                                   throws OslcException,
                                          IOException

Throws:

OslcException

IOException

loadWithAdditionalParamsAndHeaders

public Resource loadWithAdditionalParamsAndHeaders(Map<String,Object> params,
                                          Map<String,Object> headers,
                                          String... properties)
                                            throws OslcException,
                                                   IOException

Throws:

OslcException

IOException

reload

public Resource reload()
                throws OslcException,
                       IOException

Throws:

OslcException

IOException

reload

public Resource reload(String... properties)
                throws OslcException,
                       IOException

Throws:

OslcException

IOException

update

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

Update the Resource

Parameters:

jo -

Throws:

OslcException

IOException

update

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

Throws:

OslcException

IOException

merge

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

Throws:

OslcException

IOException

merge

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

Throws:

OslcException

IOException

attachmentSet

public AttachmentSet attachmentSet(String doclinkAttrName,
                          String relName)

Load the attachmentset for resource Note: there has to be a relation between them

attachmentSet

public AttachmentSet attachmentSet()
                            throws OslcException

Throws:

OslcException

relatedResource

public Resource relatedResource(String attrName)
                         throws IOException,
                                OslcException

Throws:

IOException

OslcException

invokeAction

public Resource invokeAction(String actionName,
                    javax.json.JsonObject jo)
                      throws IOException,
                             OslcException

Invoke Action

Parameters:

actionName -

jo -

Throws:

IOException

OslcException

invokeAction

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

Throws:

IOException

OslcException

delete

public void delete()
            throws IOException,
                   OslcException

Throws:

IOException

OslcException

setLoaded

public void setLoaded(boolean isLoaded)

Support pre-load resource.

Parameters:

isLoaded -