com.filenet.api.core

Class Factory.MarkingSet

java.lang.Object

com.filenet.api.core.Factory.MarkingSet

Enclosing class:

Factory

public static class Factory.MarkingSet
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static MarkingSet	createInstance(Domain domain) Creates a new instance of the MarkingSet class.
static MarkingSet	fetchInstance(Domain domain, Id id, PropertyFilter filter) Retrieves the specified MarkingSet object.
static MarkingSet	getInstance(Domain domain, Id id) Retrieves an instance of the MarkingSet class by the specified domain and ID.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createInstance

public static MarkingSet createInstance(Domain domain)

Creates a new instance of the MarkingSet class. The MarkingSet object is created when the returned instance is saved.

Parameters:

domain - The FileNet P8 domain to which the new instance is scoped.

Returns:

A MarkingSet object.

getInstance

public static MarkingSet getInstance(Domain domain,
                     Id id)

Retrieves an instance of the MarkingSet class by the specified domain and 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 type 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:

domain - The FileNet P8 domain to which the new instance is scoped.

id - The ID (GUID) of the object to retrieve.

Returns:

A reference to a MarkingSet object.

fetchInstance

public static MarkingSet fetchInstance(Domain domain,
                       Id id,
                       PropertyFilter filter)

Retrieves the specified MarkingSet object. 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 in null for the filter 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 the filter parameter.

Parameters:

domain - The FileNet P8 domain to which this object is scoped.

id - The ID (GUID) of the object to retrieve.

filter - A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.

Returns:

A MarkingSet object.