org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class Note

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.Note

public class Note
extends Reference

The object that contains instances of notes that can exist against many objects in IGC. (Note that this does not in reality extend Reference given that it has no '_type' attribute that is present on ALL other types in IGC, and hence we have some workarounds in place in this class to have it behave as if it does.)

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	belonging_to The 'belonging_to' property indicates the IGC asset that this note is attached to.
protected String	note The 'note' property of a Note contains the text of the note that was left on an object.
protected String	status The 'status' property defines the status of the note (eg.
protected String	subject The 'subject' property defines the subject of the note that was left on an object.
protected String	type The 'type' property defines the type of note this is (eg.

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
Reference	getBelongingTo() Retrieve the asset to which this IGC note belongs.
String	getName() Sets the name of the note to its RID, as Note objects do not have any name.
String	getNote() Retrieve the text of the IGC note.
String	getStatus() Retrieve the status of the note.
String	getSubject() Retrieve the subject of the note.
String	getTheType() Retrieve the type of the IGC note.
String	getType() Hard-codes the type of a Note to note, as there is no '_type' property on a an IGC note object.
void	setBelongingTo(Reference belonging_to) Set the asset to which this IGC note belongs.
void	setNote(String note) Set the text of the IGC note.
void	setStatus(String status) Set the status of the note.
void	setSubject(String subject) Set the subject of the note.
void	setTheType(String type) Set the type of the IGC note.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getNotes, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

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

Field Detail

note

protected String note

The 'note' property of a Note contains the text of the note that was left on an object.

belonging_to

protected Reference belonging_to

The 'belonging_to' property indicates the IGC asset that this note is attached to.

subject

protected String subject

The 'subject' property defines the subject of the note that was left on an object.

type

protected String type

The 'type' property defines the type of note this is (eg. "Informational", "Action", or "Other").

status

protected String status

The 'status' property defines the status of the note (eg. "Open", "Pending", or "Closed").

Constructor Detail

Note

public Note()

Method Detail

getNote

public String getNote()

Retrieve the text of the IGC note.

Returns:

String

See Also:

note

setNote

public void setNote(String note)

Set the text of the IGC note.

Parameters:

note - text of the IGC note

See Also:

note

getBelongingTo

public Reference getBelongingTo()

Retrieve the asset to which this IGC note belongs.

Returns:

Reference

See Also:

belonging_to

setBelongingTo

public void setBelongingTo(Reference belonging_to)

Set the asset to which this IGC note belongs.

Parameters:

belonging_to - the asset to which this note belongs

See Also:

belonging_to

getSubject

public String getSubject()

Retrieve the subject of the note.

Returns:

String

See Also:

subject

setSubject

public void setSubject(String subject)

Set the subject of the note.

Parameters:

subject - of the note

See Also:

subject

getTheType

public String getTheType()

Retrieve the type of the IGC note.

Returns:

String

See Also:

type

setTheType

public void setTheType(String type)

Set the type of the IGC note.

Parameters:

type - of the IGC note

See Also:

type

getStatus

public String getStatus()

Retrieve the status of the note.

Returns:

String

See Also:

status

setStatus

public void setStatus(String status)

Set the status of the note.

Parameters:

status - of the note

See Also:

status

getType

public String getType()

Hard-codes the type of a Note to note, as there is no '_type' property on a an IGC note object.

Overrides:

getType in class Reference

Returns:

String

See Also:

Reference._type

getName

public String getName()

Sets the name of the note to its RID, as Note objects do not have any name.

Overrides:

getName in class Reference

Returns:

String

See Also:

Reference._name