com.ibm.maximo.oslc

Class Attachment

java.lang.Object

com.ibm.maximo.oslc.Attachment

public class Attachment
extends Object

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

This object can be created by AttachmentSet. The following code shows how to create Attachment using AttachmentSet Constructor

 
 Attachment att = new Attachment();
 att = new AttachmentSet().create("DOCLINKS", att);
 
 

The following examples demonstrate how to build a new Attachment

 
 Attachment att = new Attachment();
 Attachment att = new Attachment(attachmenturi,maximoconnector);
 Attachment att = new Attachment(attachmentJsonObject,maximoconnector);
 
 

The following examples demonstrate how to set maximoconnector, name, description, data, metadata, wwwURI to Attachment

 
 att.mc(maximoconnector).name(filename).description(description)
 att.data(byte[] data).meta(type, storeas).wwwURI(wwwURI);
 
 

The following examples show how to load and reload data

 
 att.load();
 att.reload();
 
 

The following examples show how to get information from Attachment For file data:

 
 
 byte[] data = att.toDoc();
 String uri = att.getURI();
 String name = att.getName();
 String description = att.getDescription();
 String meta = att.getMeta();
 
 

For file metadata:

 
 JsonObject jo = att.toDocMeta(); 
 byte[] jodata = att.toDocMetaBytes();
 
 

The following example shows how to delete the Attachment

 
 att.delete(); //if the attachment is deleted as ats.att.detele(), please reload attachmentset after.
 
 

Constructor Summary

Constructors

Constructor and Description
Attachment()
Attachment(javax.json.JsonObject obj, MaximoConnector mc)
Attachment(String uri, MaximoConnector mc)

Method Summary

Methods

Modifier and Type	Method and Description
Attachment	data(byte[] data)
void	delete() Delete the attachment
Attachment	description(String description)
javax.json.JsonObject	fetchDocMeta()
String	getDescription()
String	getMeta()
String	getName()
String	getURI() Get current URI
Attachment	load() load attachment data
Attachment	load(Map<String,Object> headers) load attachment data with headers
Attachment	loadMeta() load attachment meta data
Attachment	loadMeta(Map<String,Object> headers)
Attachment	maximoConnector(MaximoConnector mc) Attachment att = new Attachment().mc(params)
Attachment	meta(String type, String storeas)
Attachment	name(String name)
Attachment	reload()
Attachment	reloadMeta()
byte[]	toDoc()
javax.json.JsonObject	toDocMeta() Get Attachment data in JSON
byte[]	toDocMetaBytes() Get Attachment data in JSONBytes
Attachment	wwwURI(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

Attachment

public Attachment()

Attachment

public Attachment(String uri,
          MaximoConnector mc)

Attachment

public Attachment(javax.json.JsonObject obj,
          MaximoConnector mc)

Method Detail

maximoConnector

public Attachment maximoConnector(MaximoConnector mc)

Attachment att = new Attachment().mc(params)

Parameters:

mc -

name

public Attachment name(String name)

description

public Attachment description(String description)

meta

public Attachment meta(String type,
              String storeas)

wwwURI

public Attachment wwwURI(String uri)

data

public Attachment data(byte[] data)

getName

public String getName()

getDescription

public String getDescription()

getMeta

public String getMeta()

toDoc

public byte[] toDoc()
             throws IOException,
                    OslcException

Throws:

IOException

OslcException

getURI

public String getURI()

Get current URI

toDocMeta

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

Get Attachment data in JSON

Throws:

IOException

OslcException

toDocMetaBytes

public byte[] toDocMetaBytes()
                      throws OslcException,
                             IOException

Get Attachment data in JSONBytes

Throws:

IOException

OslcException

load

public Attachment load()
                throws IOException,
                       OslcException

load attachment data

Throws:

OslcException

IOException

load

public Attachment load(Map<String,Object> headers)
                throws IOException,
                       OslcException

load attachment data with headers

Parameters:

headers -

Throws:

IOException

OslcException

reload

public Attachment reload()
                  throws IOException,
                         OslcException

Throws:

IOException

OslcException

loadMeta

public Attachment loadMeta()
                    throws IOException,
                           OslcException

load attachment meta data

Throws:

IOException

OslcException

loadMeta

public Attachment loadMeta(Map<String,Object> headers)
                    throws IOException,
                           OslcException

Throws:

IOException

OslcException

reloadMeta

public Attachment reloadMeta()
                      throws IOException,
                             OslcException

Throws:

IOException

OslcException

fetchDocMeta

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

Throws:

IOException

OslcException

delete

public void delete()
            throws IOException,
                   OslcException

Delete the attachment

Throws:

IOException

OslcException