oracle.ifs.fdk
Class Item

java.lang.Object
  oracle.ifs.fdk.Item

All Implemented Interfaces:

java.io.Serializable

public class Item

extends java.lang.Object

implements java.io.Serializable

Represents an item abstraction of a persistent repository object, such as a document, folder, link, user, group, category, etc. The type of items are defined by the type safe enum ItemType.

An Item always contains three attributes:

1. ID - the ID of the persistent repository object
2. NAME - the name of the repository object
3. TYPE - the type of the object

An Item may also contain an optional number of attributes that the caller may be interested in and explicitly requests.

Constructor Summary

Item()
Default constructor in other to be a Java Bean.

Method Summary

long	getId() Returns the ID of the item.
java.lang.String	getName() Returns the name of the item.
NamedValue[]	getRequestedAttributes() Returns the optionally requested attributes of the item or null if no optional attributes are present.
java.lang.String	getType() Returns the type of the item.
java.lang.String	toString() Returns a string representation of an item.

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item()

Default constructor in other to be a Java Bean.

Do NOT use this constructor, it will thorw a RuntimeException

Method Detail

getId

public long getId()

Returns the ID of the item.

getName

public java.lang.String getName()

Returns the name of the item.

getType

public java.lang.String getType()

Returns the type of the item. The return value is one of the constants defined in ItemTypes, hence when running in-process it is recommended that the return value is compared against one of the constants using the double-equal "==" operator rather than equals().

getRequestedAttributes

public NamedValue[] getRequestedAttributes()

Returns the optionally requested attributes of the item or null if no optional attributes are present. Note that the return value does not include the ID, NAME and TYPE attributes.

NOTE: When running the client code in-process, the method attributesMap() MUST be used instead. It will be more efficient to retrieve the attributes from a map than from an array.

toString

public java.lang.String toString()

Returns a string representation of an item.

NOTE: Calling this method is not cheap, protect debugging code so that the string is not computed unnecessarily when not in debug mode.