com.filenet.api.core
Class Factory.ClassDescription
- java.lang.Object
-
- com.filenet.api.core.Factory.ClassDescription
-
- Enclosing class:
- Factory
public static class Factory.ClassDescription extends java.lang.Object
-
-
Method Summary
Methods Modifier and Type Method and Description static ClassDescription
fetchInstance(Scope scope, Id classId, PropertyFilter filter)
Retrieves an object of theClassDescription
class specified by the given class ID.static ClassDescription
fetchInstance(Scope scope, java.lang.String classIdentity, PropertyFilter filter)
Retrieves an object of theClassDescription
class specified by the given identity.static ClassDescription
getInstance(Scope scope, Id classId)
Retrieves the instance of theClassDescription
class specified by the given scope and class ID.static ClassDescription
getInstance(Scope scope, java.lang.String classIdentity)
Retrieves the instance of theClassDescription
class specified by the given scope and class identity.
-
-
-
Method Detail
-
getInstance
public static ClassDescription getInstance(Scope scope, Id classId)
Retrieves the instance of theClassDescription
class specified by the given scope and class ID. This method does not verify the existence of the requested object on the server; it simply returns a local reference without making a round-trip to the server. The local reference is not affiliated with an object of this class until you perform a function on the object (for example, fetch a property value) that causes a round-trip to the Content Engine server.- Parameters:
scope
- The object to which thisClassDescription
is scoped. For more information, see theScope
interface description.classId
- The ID (GUID) of the requested class instance.- Returns:
- The requested
ClassDescription
object.
-
getInstance
public static ClassDescription getInstance(Scope scope, java.lang.String classIdentity)
Retrieves the instance of theClassDescription
class specified by the given scope and class identity. This method does not verify the existence of the requested object on the server; it simply returns a local reference without making a round-trip to the server. The local reference is not affiliated with an object of this class until you perform a function on the object (for example, fetch a property value) that causes a round-trip to the Content Engine server.- Parameters:
scope
- The object to which thisClassDescription
is scoped. For more information, see theScope
interface description.classIdentity
- AString
that identifies the class. The value can be a class ID (in GUID format) or class symbolic name.- Returns:
- The requested
ClassDescription
object.
-
fetchInstance
public static ClassDescription fetchInstance(Scope scope, Id classId, PropertyFilter filter)
Retrieves an object of theClassDescription
class specified by the given class ID. This method always makes a round-trip to the server. You can optionally include a filter to control which properties to return with the object. If you pass innull
for thefilter
parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of thefilter
parameter.- Parameters:
scope
- The object to which thisClassDescription
is scoped. For more information, see theScope
interface description.classId
- The ID (GUID) of the requested class instance.filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.REFERENCE
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.- Returns:
- The requested
ClassDescription
object.
-
fetchInstance
public static ClassDescription fetchInstance(Scope scope, java.lang.String classIdentity, PropertyFilter filter)
Retrieves an object of theClassDescription
class specified by the given identity. This method always makes a round-trip to the server. You can optionally include a filter to control which properties to return with the object. If you pass innull
for thefilter
parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of thefilter
parameter.- Parameters:
scope
- The object to which thisClassDescription
is scoped. For more information, see theScope
interface description.classIdentity
- AString
that identifies the class. The value can be a class ID (in GUID format) or class symbolic name.filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.REFERENCE
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.- Returns:
- The requested
ClassDescription
object.
-
-