com.ibm.casemgmt.api.objectref

Class ObjectStoreReference


  • public class ObjectStoreReference
extends CEObjectReference<com.filenet.api.core.ObjectStore,DomainReference>
    Represents a reference to a Content Engine Java API ObjectStore object. An ObjectStore instance has a parent object reference of type DomainReference.

    An ObjectStoreReference can be constructed using a parent DomainReference and a name or ID. The name can be the object store symbolic name or display name.

    An ObjectStoreReference can also be constructed using an existing Content Engine Java API ObjectStore object.

    ID status:
    ID review by David Newhall

    • Constructor Detail

      • ObjectStoreReference

        public ObjectStoreReference(DomainReference domainRef,
                            java.lang.String osName)
        Constructs an ObjectStoreReference instance using a parent DomainReference object and a name. The name can be the symbolic name or display name.
        Parameters:
        domainRef - the parent DomainReference object
        osName - the object store symbolic name or display name
        ID status:
        ID review by David Newhall

      • ObjectStoreReference

        public ObjectStoreReference(DomainReference domainRef,
                            com.filenet.api.util.Id osId)
        Constructs an ObjectStoreReference instance using a parent DomainReference object and an ID.
        Parameters:
        domainRef - the parent DomainReference object
        osId - the object store ID
        ID status:
        ID review by David Newhall

      • ObjectStoreReference

        public ObjectStoreReference(com.filenet.api.core.ObjectStore os)
        Constructs an ObjectStoreReference instance using an existing Content Engine Java API ObjectStore object. Information such as the object store identity is obtained from the existing ObjectStore object but the {code ObjectStore} object itself is not maintained on this instance.
        Parameters:
        os - an existing ObjectStore object.
        ID status:
        ID review by David Newhall

    • Method Detail

      • fetchCEObject

        public com.filenet.api.core.ObjectStore fetchCEObject(com.filenet.api.property.PropertyFilter pf)
        Fetches a Content Engine Java API ObjectStore object. Equivalent to calling the Factory.ObjectStore.fetchInstance method with a Domain object corresponding to the parent DomainReference object, the ID or name this instance references, and the specified property filter.
        Specified by:
        fetchCEObject in class CEObjectReference<com.filenet.api.core.ObjectStore,DomainReference>
        Parameters:
        pf - optional property filter
        ID status:
        ID review by David Newhall

      • getFetchlessCEObject

        public com.filenet.api.core.ObjectStore getFetchlessCEObject()
        Obtains a fetchless instance of a Content Engine Java API ObjectStore object. Equivalent to calling the Factory.ObjectStore.getInstance method with a Domain object corresponding to the parent DomainReference object and the ID or name this instance references.
        Specified by:
        getFetchlessCEObject in class CEObjectReference<com.filenet.api.core.ObjectStore,DomainReference>
        ID status:
        ID review by David Newhall

      • getObjectStoreIdentity

        public java.lang.String getObjectStoreIdentity()
        Returns the identity as either an ID or a name, however it is represented in the reference.
        ID status:
        ID review by David Newhall
Skip navigation links