FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface BaseObject

All Superinterfaces:
java.io.Serializable, ValueObject
All Known Subinterfaces:
Annotation, ChoiceList, ChoiceList, ClassDescription, ClassDescription, ContainableObject, CreatableObject, CustomObject, Document, Document, Domain, DynamicReferentialContainmentRelationship, Event, EventAction, FeatureAddOn, Folder, Folder, GettableObject, Group, Link, LockableObject, MarkingSet, ObjectStore, ObjectStore, PanagonObject, PropertyDescription, PropertyDescription, PublishRequest, PublishTemplate, ReadableMetadataObject, ReadableSecurityObject, Realm, ReferentialContainmentRelationship, SearchPropertyDescription, SecurityGrantee, SecurityPolicy, StoredSearch, StyleTemplate, Subscription, User, VersionableObject, VersionSeries, WorkflowDefinition, WorkflowSubscription, WorkflowTarget, WriteableMetadataObject, WriteableSecurityObject

public interface BaseObject
extends java.io.Serializable, ValueObject

The BaseObject interface is the base from which most of the interfaces in the com.filenet.wcm.api package derive derive. Its methods provide base functionality for retrieving class and object store (library) identifiers, object IDs, names, and types. These method are especially useful for identifying objects in a BaseeObjects collection. BaseObject is a thread-safe class.

You can call methods on some interfaces (such as Folder and ObjectStore) to retrieve a BaseObject object or a BaseObjects collection object. As an example, to get the contents of a folder, call one of the forms of getContainees on the Folder interface, which returns a BaseObjects collection. Each element of the returned collection represents an object (such as a subfolder or document) contained within the parent folder.

The BaseObject interface also contains constants for all object types used within the Content Services server. (Included are some object types from the Content Services server that are not used in the CS Java Connector.) Use these constants to determine or specify the type of object you are working with. For example, when calling ObjectStore.getObject() to get a reference to a Document object on the Content Services server, specify BaseObject.TYPE_DOCUMENT for the objectType parameter.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
static int EXPORT_DEFAULT
          

Not Implemented in CS Java Connector v3.0.

static int EXPORT_ENCODED_CONTENT
          

Not Implemented in CS Java Connector v3.0.

static int EXPORT_FULL
          

Not Implemented in CS Java Connector v3.0.

static int EXPORT_OBJECT_ID
          

Not Implemented in CS Java Connector v3.0.

static int EXPORT_OBJECT_SECURITY
          

Not Implemented in CS Java Connector v3.0.

static int IMPORT_DEFAULT
          

Not Implemented in CS Java Connector v3.0.

static int IMPORT_OBJECT_ID
          

Not Implemented in CS Java Connector v3.0.

static int IMPORT_OWNER
          

Not Implemented in CS Java Connector v3.0.

static int IMPORT_PERMISSIONS
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_ACTIVE_MARKING
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_ANNOTATION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_ANY
          Value of 0; represents an object for which the object type is unknown until the object is instantiated.
static int TYPE_CBR_ENGINE_TYPE
          Value of 2009; represents a CBREngineType object.
static int TYPE_CHOICE
          Value of 1025; represent a Choice object.
static int TYPE_CHOICELIST
          Value of 1026; represents a ChoiceList object.
static int TYPE_CLASS_SUBSCRIPTION
          Value of 1166; represents a ClassSubscription object.
static int TYPE_CLASSDEFINITION
          Value of 1027; represents a ClassDefinition object.
static int TYPE_CLASSDESCRIPTION
          Value of 25; represents a ClassDescription object.
static int TYPE_COLUMN_DEFINITION
          Value of 1028; represents a ColumnDefinition object.
static int TYPE_COMPUTER
          Value of 2003; represents a Computer object.
static int TYPE_CONTENT_CACHE_SERVICE
          Value of 2011; represents a Content Services ContentCacheService object.
static int TYPE_CONTENT_MGR_SERVICE
          Value of 2010; represents a Content Services ContentManagerService object.
static int TYPE_CONTENT_REFERENCE
          Value of 1035; represents a ContentReference object.
static int TYPE_CONTENT_TRANSFER
          Value of 1038; represents a ContentTransfer object.
static int TYPE_CUSTOMOBJECT
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_DOCUMENT
          Value of 1; represents a Document object type.
static int TYPE_DOCUMENT_CLASSIFICATION_ACTION
          Value of 1161; represents a DocumentClassificationAction object.
static int TYPE_DOCUMENT_LIFECYCLE_ACTION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_DOCUMENT_LIFECYCLE_POLICY
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_DOCUMENTSTATE
          Value of 1152; represents a DocumentState object.
static int TYPE_DOMAIN
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP
          Value of 1050; represents a DynamicReferentialContainmentRelationship.
static int TYPE_ENTIRENETWORK
          Value of 2004; represents an EntireNetwork object.
static int TYPE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_EVENT_ACTION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_FEATURE_ADD_ON
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_FILESTORE
          Value of 2008; represents a Content Services FileStore object.
static int TYPE_FOLDER
          Value of 2; represents a Folder object.
static int TYPE_GROUP
          Value of 2001; represents a Group object.
static int TYPE_INSTANCE_SUBSCRIPTION
          Value of 1165; represents an InstanceSubscription object.
static int TYPE_LINK
          Value of 1156; represents a Link object.
static int TYPE_LOCALIZED_STRING
          Value of 1075; represents a LocalizedString object.
static int TYPE_MARKING_SET
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_MULTIPLEVALUES
          Value of 1066; represents a MultipleValues object.
static int TYPE_OBJECT_STORE
          Value of 4; represents an ObjectStore object.
static int TYPE_OBJECTSET
          Value of 14; represents an ObjectSet object.
static int TYPE_OBJSTORE_SERVICE
          Value of 2007; represents a Content Services ObjectStoreService object.
static int TYPE_PERMISSION
          Value of 2012; represents a Permission object.
static int TYPE_PROPERTY_DEFINITION
          Value of 1077; represents a PropertyDefinition object.
static int TYPE_PROPERTYDESCRIPTION
          Value of 24; represents a PropertyDescription object.
static int TYPE_PROPERTYDESCRIPTIONS
          Value of 1142; represents a PropertyDescriptions collection object.
static int TYPE_PUBLISH_REQUEST
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_PUBLISH_TEMPLATE
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_READONLY_OBJECT_SET
          Value of 2002; represents a ReadonlyObjectSet object.
static int TYPE_REALM
          Value of 2006; represents a Realm object.
static int TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP
          Value of 1124; represents a ReferentialContainmentRelationship object.
static int TYPE_SECURITY_POLICY
          Value of 1170; represents a SecurityPolicy object.
static int TYPE_SECURITY_TEMPLATE
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_STORAGE_POLICY
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_STORED_SEARCH
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_STYLE_TEMPLATE
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_SUBSCRIPTION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_TABLE_DEFINITION
          Value of 1135; represents a TableDefinition object.
static int TYPE_TRANSIENT
          Value of 1137; represents a Transient object.
static int TYPE_USER
          Value of 2000; represents a User object.
static int TYPE_VERSIONSERIES
          Value of 1140; represents a VersionSeries object.
static int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_WORKFLOWDEFINITION
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_XML_PROPERTY_MAPPING_SCRIPT
          Value of 1162; represents an XMLPropertyMappingScript object.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares two BaseObject instances for logical equivalence, meaning that they refer to the same Content Services object.
 java.lang.String exportObject(int flags, java.lang.String exportFilter)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getClassId()
          Returns a String identifying the object's class.
 java.lang.String getId()
          Returns the value of the object's IdmId.
 java.lang.String getName()
          Returns the value of the object's idmName property as a String.
 java.lang.String getObjectStoreId()
          Returns the the object store location in which the BaseObject object is stored.
 int getObjectType()
          Returns an integer that identifies an object's base type.
 Session getSession()
          Returns the Session object that was used when this BaseObject object was instantiated.
 int hashCode()
          Overrides java.lang.Object.hashCode().
 BaseObject thisBaseObject()
          

Not Implemented in CS Java Connector v3.0.

 

Field Detail

TYPE_PROPERTYDESCRIPTION

public static final int TYPE_PROPERTYDESCRIPTION
Value of 24; represents a PropertyDescription object.

See Also:
Constant Field Values

TYPE_MULTIPLEVALUES

public static final int TYPE_MULTIPLEVALUES
Value of 1066; represents a MultipleValues object.

See Also:
Constant Field Values

TYPE_OBJECTSET

public static final int TYPE_OBJECTSET
Value of 14; represents an ObjectSet object.

See Also:
Constant Field Values

TYPE_PROPERTYDESCRIPTIONS

public static final int TYPE_PROPERTYDESCRIPTIONS
Value of 1142; represents a PropertyDescriptions collection object.

See Also:
Constant Field Values

TYPE_CLASSDESCRIPTION

public static final int TYPE_CLASSDESCRIPTION
Value of 25; represents a ClassDescription object.

See Also:
Constant Field Values

TYPE_OBJECT_STORE

public static final int TYPE_OBJECT_STORE
Value of 4; represents an ObjectStore object.

See Also:
Constant Field Values

TYPE_DOCUMENT

public static final int TYPE_DOCUMENT
Value of 1; represents a Document object type.

See Also:
Constant Field Values

TYPE_VERSIONSERIES

public static final int TYPE_VERSIONSERIES
Value of 1140; represents a VersionSeries object.

See Also:
Constant Field Values

TYPE_FOLDER

public static final int TYPE_FOLDER
Value of 2; represents a Folder object.

See Also:
Constant Field Values

TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP

public static final int TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP
Value of 1124; represents a ReferentialContainmentRelationship object.

See Also:
Constant Field Values

TYPE_CONTENT_TRANSFER

public static final int TYPE_CONTENT_TRANSFER
Value of 1038; represents a ContentTransfer object.

See Also:
Constant Field Values

TYPE_CONTENT_REFERENCE

public static final int TYPE_CONTENT_REFERENCE
Value of 1035; represents a ContentReference object.

See Also:
Constant Field Values

TYPE_CUSTOMOBJECT

public static final int TYPE_CUSTOMOBJECT

Not Implemented in CS Java Connector v3.0.

Value of 15; represents a CustomObject object.

See Also:
Constant Field Values

TYPE_TRANSIENT

public static final int TYPE_TRANSIENT
Value of 1137; represents a Transient object.

See Also:
Constant Field Values

TYPE_CLASSDEFINITION

public static final int TYPE_CLASSDEFINITION
Value of 1027; represents a ClassDefinition object.

See Also:
Constant Field Values

TYPE_PROPERTY_DEFINITION

public static final int TYPE_PROPERTY_DEFINITION
Value of 1077; represents a PropertyDefinition object.

See Also:
Constant Field Values

TYPE_LOCALIZED_STRING

public static final int TYPE_LOCALIZED_STRING
Value of 1075; represents a LocalizedString object.

See Also:
Constant Field Values

TYPE_TABLE_DEFINITION

public static final int TYPE_TABLE_DEFINITION
Value of 1135; represents a TableDefinition object.

See Also:
Constant Field Values

TYPE_COLUMN_DEFINITION

public static final int TYPE_COLUMN_DEFINITION
Value of 1028; represents a ColumnDefinition object.

See Also:
Constant Field Values

TYPE_CHOICELIST

public static final int TYPE_CHOICELIST
Value of 1026; represents a ChoiceList object.

See Also:
Constant Field Values

TYPE_CHOICE

public static final int TYPE_CHOICE
Value of 1025; represent a Choice object.

See Also:
Constant Field Values

TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP

public static final int TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP
Value of 1050; represents a DynamicReferentialContainmentRelationship.

See Also:
Constant Field Values

TYPE_ANNOTATION

public static final int TYPE_ANNOTATION

Not Implemented in CS Java Connector v3.0.

Value of 3; represents an Annotation object.

See Also:
Constant Field Values

TYPE_SUBSCRIPTION

public static final int TYPE_SUBSCRIPTION

Not Implemented in CS Java Connector v3.0.

Value of 1144; represents a Subscription object.

See Also:
Constant Field Values

TYPE_DOCUMENT_LIFECYCLE_POLICY

public static final int TYPE_DOCUMENT_LIFECYCLE_POLICY

Not Implemented in CS Java Connector v3.0.

Value of 1148; represents a DocumentLifecyclePolicy object.

See Also:
Constant Field Values

TYPE_DOCUMENTSTATE

public static final int TYPE_DOCUMENTSTATE
Value of 1152; represents a DocumentState object.

See Also:
Constant Field Values

TYPE_DOCUMENT_LIFECYCLE_ACTION

public static final int TYPE_DOCUMENT_LIFECYCLE_ACTION

Not Implemented in CS Java Connector v3.0.

Value of 1154; represents a DocumentLifecycleAction object.

See Also:
Constant Field Values

TYPE_USER

public static final int TYPE_USER
Value of 2000; represents a User object.

See Also:
Constant Field Values

TYPE_GROUP

public static final int TYPE_GROUP
Value of 2001; represents a Group object.

See Also:
Constant Field Values

TYPE_READONLY_OBJECT_SET

public static final int TYPE_READONLY_OBJECT_SET
Value of 2002; represents a ReadonlyObjectSet object.

See Also:
Constant Field Values

TYPE_COMPUTER

public static final int TYPE_COMPUTER
Value of 2003; represents a Computer object.

See Also:
Constant Field Values

TYPE_LINK

public static final int TYPE_LINK
Value of 1156; represents a Link object.

See Also:
Constant Field Values

TYPE_INSTANCE_SUBSCRIPTION

public static final int TYPE_INSTANCE_SUBSCRIPTION
Value of 1165; represents an InstanceSubscription object.

See Also:
Constant Field Values

TYPE_CLASS_SUBSCRIPTION

public static final int TYPE_CLASS_SUBSCRIPTION
Value of 1166; represents a ClassSubscription object.

See Also:
Constant Field Values

TYPE_STORAGE_POLICY

public static final int TYPE_STORAGE_POLICY

Not Implemented in CS Java Connector v3.0.

Value of 1037; represents a StoragePolicy object.

See Also:
Constant Field Values

TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION

public static final int TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION

Not Implemented in CS Java Connector v3.0.

Value of 1165; represents a WorkflowSubscription object.

See Also:
Constant Field Values

TYPE_WORKFLOW_CLASS_SUBSCRIPTION

public static final int TYPE_WORKFLOW_CLASS_SUBSCRIPTION

Not Implemented in CS Java Connector v3.0.

Value of 1166; represents a WorkflowClassSubscription object.

See Also:
Constant Field Values

TYPE_EVENT_ACTION

public static final int TYPE_EVENT_ACTION

Not Implemented in CS Java Connector v3.0.

Value of 1143; represents an EventAction object.

See Also:
Constant Field Values

TYPE_WORKFLOWDEFINITION

public static final int TYPE_WORKFLOWDEFINITION

Not Implemented in CS Java Connector v3.0.

Value of 1160; represents a WorkflowDefinition object.

See Also:
Constant Field Values

TYPE_DOCUMENT_CLASSIFICATION_ACTION

public static final int TYPE_DOCUMENT_CLASSIFICATION_ACTION
Value of 1161; represents a DocumentClassificationAction object.

See Also:
Constant Field Values

TYPE_XML_PROPERTY_MAPPING_SCRIPT

public static final int TYPE_XML_PROPERTY_MAPPING_SCRIPT
Value of 1162; represents an XMLPropertyMappingScript object.

See Also:
Constant Field Values

TYPE_ANY

public static final int TYPE_ANY
Value of 0; represents an object for which the object type is unknown until the object is instantiated. See the getObject method on the ObjectStore interface for additional information.

See Also:
Constant Field Values

TYPE_SECURITY_POLICY

public static final int TYPE_SECURITY_POLICY
Value of 1170; represents a SecurityPolicy object.

See Also:
Constant Field Values

TYPE_SECURITY_TEMPLATE

public static final int TYPE_SECURITY_TEMPLATE

Not Implemented in CS Java Connector v3.0.

Value of 1175; represents a SecurityTemplate object.

See Also:
Constant Field Values

TYPE_ENTIRENETWORK

public static final int TYPE_ENTIRENETWORK
Value of 2004; represents an EntireNetwork object.

See Also:
Constant Field Values

TYPE_DOMAIN

public static final int TYPE_DOMAIN

Not Implemented in CS Java Connector v3.0.

Value of 2005; represents a Domain object.

See Also:
Constant Field Values

TYPE_REALM

public static final int TYPE_REALM
Value of 2006; represents a Realm object.

See Also:
Constant Field Values

TYPE_OBJSTORE_SERVICE

public static final int TYPE_OBJSTORE_SERVICE
Value of 2007; represents a Content Services ObjectStoreService object. This object represents a service that provides the object store capabilities required to create a new ObjectStore object, and create and manage folders, document classes, properties, content storage, storage policies, choice lists, and other metadata associated with an object store.

See Also:
Constant Field Values

TYPE_FILESTORE

public static final int TYPE_FILESTORE
Value of 2008; represents a Content Services FileStore object. This object represents a computer file storage area that is used by an ObjectStore object.

See Also:
Constant Field Values

TYPE_CBR_ENGINE_TYPE

public static final int TYPE_CBR_ENGINE_TYPE
Value of 2009; represents a CBREngineType object. A CBREngineType object represents a third party content-based retrieval (CBR) engine.

See Also:
Constant Field Values

TYPE_CONTENT_MGR_SERVICE

public static final int TYPE_CONTENT_MGR_SERVICE
Value of 2010; represents a Content Services ContentManagerService object. This object represents a service that provides content management capabilities, such as determining which content updates to a FileStore are accepted and which are locked.

See Also:
Constant Field Values

TYPE_CONTENT_CACHE_SERVICE

public static final int TYPE_CONTENT_CACHE_SERVICE
Value of 2011; represents a Content Services ContentCacheService object. This object represents a service that provides content caching capabilities, such as caching document-related content in memory.

See Also:
Constant Field Values

TYPE_PERMISSION

public static final int TYPE_PERMISSION
Value of 2012; represents a Permission object. This object represents a rule associated with an object that regulates which users can gain access to an object and in what manner.

See Also:
Constant Field Values

TYPE_EVENT

public static final int TYPE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of 1180; represents an Event object. This object represents an auditable event (such as checking in a document, updating a property, or creating a new object instance) that occurs on an object that can be audited.

See Also:
Constant Field Values

TYPE_FEATURE_ADD_ON

public static final int TYPE_FEATURE_ADD_ON

Not Implemented in CS Java Connector v3.0.

Value of 1202; represents a FeatureAddOn object. This object represents a product extension to the core FileNet P8 server base components.

See Also:
Constant Field Values

TYPE_MARKING_SET

public static final int TYPE_MARKING_SET

Not Implemented in CS Java Connector v3.0.

Value of 1200; represents a MarkingSet object. This object represents a set of Marking objects, each of which defines a possible marking value for a single or multi-valued property of an object.

See Also:
Constant Field Values

TYPE_ACTIVE_MARKING

public static final int TYPE_ACTIVE_MARKING

Not Implemented in CS Java Connector v3.0.

Value of 1210; represents an ActiveMarking object. This object represents a marking that is currently assigned to an object.

See Also:
Constant Field Values

TYPE_STORED_SEARCH

public static final int TYPE_STORED_SEARCH

Not Implemented in CS Java Connector v3.0.

Value of -100; represents a StoredSearch object.

See Also:
Constant Field Values

TYPE_PUBLISH_TEMPLATE

public static final int TYPE_PUBLISH_TEMPLATE

Not Implemented in CS Java Connector v3.0.

Value of -101; represents a PublishTemplate object.

See Also:
Constant Field Values

TYPE_PUBLISH_REQUEST

public static final int TYPE_PUBLISH_REQUEST

Not Implemented in CS Java Connector v3.0.

Value of -102; represents a PublishRequest object.

See Also:
Constant Field Values

TYPE_STYLE_TEMPLATE

public static final int TYPE_STYLE_TEMPLATE

Not Implemented in CS Java Connector v3.0.

Value of -103; represents a StyleTemplate object.

See Also:
Constant Field Values

IMPORT_DEFAULT

public static final int IMPORT_DEFAULT

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

IMPORT_OBJECT_ID

public static final int IMPORT_OBJECT_ID

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

IMPORT_PERMISSIONS

public static final int IMPORT_PERMISSIONS

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

IMPORT_OWNER

public static final int IMPORT_OWNER

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

EXPORT_DEFAULT

public static final int EXPORT_DEFAULT

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

EXPORT_OBJECT_ID

public static final int EXPORT_OBJECT_ID

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

EXPORT_OBJECT_SECURITY

public static final int EXPORT_OBJECT_SECURITY

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

EXPORT_ENCODED_CONTENT

public static final int EXPORT_ENCODED_CONTENT

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

EXPORT_FULL

public static final int EXPORT_FULL

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values
Method Detail

thisBaseObject

public BaseObject thisBaseObject()

Not Implemented in CS Java Connector v3.0.

Returns the currently referenced BaseObject object.

Any caller implementation class that implements BaseObject (or any of the subinterfaces of BaseObject) must have an internal reference to a BaseObject object provided by the Content Services Java Connector. This method is required to provide the reference to that enclosed ("wrapped") Content Services Java Connector BaseObject. Callers who subclass can simply forward to the enclosed object or return a reference to the enclosed object.

This method is declared as returning a BaseObject object, but the returned object should be appropriate to the interface being implemented. For example, for a class that implements Folder, the thisBaseObject method should return a Folder object. If it does not, a type mismatch exception can occur.

Returns:
A BaseObject.


getId

public java.lang.String getId()
Returns the value of the object's IdmId. This method is equivalent to calling getPropertyStringValue(com.filenet.Panagon.PanagonObject.IdmId). Use this method to retrieve the ID to use as an argument in methods such as ObjectStore.getObject

Returns:
A String representing the ID of an object.

getName

public java.lang.String getName()
Returns the value of the object's idmName property as a String. This method is equivalent to calling getPropertyStringValue(com.filenet.Panagon.PanagonObject.idmName).

Returns:
A String representing the name of the object. Can be null or an empty String.

getObjectStoreId

public java.lang.String getObjectStoreId()
Returns the the object store location in which the BaseObject object is stored. The returned string is a concatenation of the library name, the carat character, and host machine name, for example: Aslan^Narnia.

Returns:
A String identifying the object store location where this BaseObject exists.

getClassId

public java.lang.String getClassId()
Returns a String identifying the object's class.

For a Document object, the class identifier is the name of the Document object's class, for example "General". The class identifier for a Folder, ObjectStore, and StoredSearch object is the class type, that is, _BASE_FOLDER, _BASE_CATALOG, and _BASE_STORED_SEARCH, respectively.

For other objects, BaseObject.getClassId() returns a GUID identifying an object’s class. GUIDs are defined as fields in the com.filenet.wcm.api.ClassDescription interface. keep in mind that the returned GUID only identifies the object's class as defined in the CS Java Connector. The returned GUID is not the ID of the class description as defined on Content Services. Nor can the returned GUID be used to retrieve a ClassDescription object.

Returns:
A String that is the name of the object's class. Returns null for objects outside of the Content Services server.

getObjectType

public int getObjectType()
Returns an integer that identifies an object's base type. For example, this method returns 1 for Document, 2 for Folder, and 4 for ObjectStore.

When working with methods that require an object type as an argument, use this method to retrieve the object type. For example, the argument to getClassDescriptions(objTypes) on the ObjectStore interface is an int array that specifies the object types for which you want to retrieve class descriptions. To retrieve a Document object's class description, call getObjectType() to retrieve its object type value (1), add the returned integer (or its equivalent constant defined in the BaseObject interface) to the array, and pass the array as the argument to the ObjectStore.getClassDescriptions(objTypes) call.

Returns:
An integer representing this object type.

getSession

public Session getSession()
Returns the Session object that was used when this BaseObject object was instantiated.

Returns:
A Session object.

exportObject

public java.lang.String exportObject(int flags,
                                     java.lang.String exportFilter)

Not Implemented in CS Java Connector v3.0.


equals

public boolean equals(java.lang.Object o)
Compares two BaseObject instances for logical equivalence, meaning that they refer to the same Content Services object.

Two BaseObject objects are considered logically equivalent if the following values of both objects match:

For its internal calculations, this method requires that the ID of the object and the ID of the containing object store be available in GUID format, not as names or paths. As an example, if the object were instantiated by calling ObjectStore.getObject(type, "/some/path"), the path name, not the GUID, would identify the object internally. Similarly, if you called ObjectFactory.getObjectStore("SomeNonGUIDName", session), the returned ObjectStore object's GUID would not be available. If GUIDs are not available, this method makes one or more round trips to the Content Services server, using the available path or name to locate and return the associated GUID. Once the GUIDs have been fetched, they are remembered, so calling this method multiple times involving the same objects will not result in repeated round trips. If the supplied name or path is invalid, this method throws a BadReferenceException.

Parameters:
o - The BaseObject object with which to compare.

Returns:
true if the two objects are logically equivalent; otherwise, false.
See Also:
Session.equals(Object)

hashCode

public int hashCode()
Overrides java.lang.Object.hashCode(). This method returns an integer for the hash code for this BaseObject. The hash code is used for storing and retrieving a reference to this object in a Hashtable data structure.

For its internal calculations, this method requires that the ID of the object and the ID of the containing object store be available in GUID format, not as names or paths. As an example, if the object were instantiated by calling ObjectStore.getObject(type, "/some/path"), the path name, not the GUID, would identify the object internally. Similarly, if you called ObjectFactory.getObjectStore("SomeNonGUIDName", session), the returned ObjectStore object's GUID would not be available. If GUIDs are not available, this method makes one or more round trips to the Content Services server, using the available path or name to locate and return the associated GUID. Once the GUIDs have been fetched, they are remembered, so calling this method multiple times involving the same objects will not result in repeated round trips. If the supplied name or path is invalid, this method throws an "object not found" exception.

Returns:
An int representing the hash code for this object reference.

FileNet Content Services
Java Connector v3.0