com.filenet.api.core

Class Factory.CmLocalGroup

java.lang.Object

com.filenet.api.core.Factory.CmLocalGroup

Enclosing class:

Factory

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

Method Summary

Modifier and Type	Method and Description
static CmLocalGroup	createInstance(Domain domain, Id id) Creates a new instance of the CmLocalGroup class based on the specified parameters.
static CmLocalGroup	fetchInstance(Domain domain, Id id, PropertyFilter filter) Retrieves an object of the CmLocalGroup class by the specified domain and ID.
static CmLocalGroup	fetchInstance(Domain domain, java.lang.String name, PropertyFilter filter) Retrieves the specified object from this CmLocalGroup object.
static CmLocalGroup	fetchInstance(Group group, PropertyFilter filter) Retrieves an instance of the CmLocalGroup class corresponding to a specified Group.
static CmLocalGroup	getInstance(Domain domain, Id id) Constructs an instance of the CmLocalGroup class by the specified domain and ID.
static CmLocalGroup	getInstance(Domain domain, java.lang.String name) Constructs an instance of the CmLocalGroup class by the specified domain and name.
static CmLocalGroup	getInstance(Group group) Constructs an instance of the CmLocalGroup class corresponding to a specified Group.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CmLocalGroup getInstance(Domain domain,
                                       java.lang.String name)

Constructs an instance of the CmLocalGroup class by the specified domain and name. 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 this object is scoped.

name - The name of the class instance to retrieve.

Returns:

A reference to an CmLocalGroup object.

getInstance

public static CmLocalGroup getInstance(Group group)

Constructs an instance of the CmLocalGroup class corresponding to a specified Group. 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:

group - The Group object for which the corresponding CmLocalGroup instance is to be returned

Returns:

A reference to an CmLocalGroup object.

fetchInstance

public static CmLocalGroup fetchInstance(Domain domain,
                                         java.lang.String name,
                                         PropertyFilter filter)

Retrieves the specified object from this CmLocalGroup 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.

name - The name of the class instance 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:

An CmLocalGroup.

fetchInstance

public static CmLocalGroup fetchInstance(Group group,
                                         PropertyFilter filter)

Retrieves an instance of the CmLocalGroup class corresponding to a specified Group. 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:

group - The Group object for which the corresponding CmLocalGroup instance is to be returned

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:

An CmLocalGroup.

getInstance

public static CmLocalGroup getInstance(Domain domain,
                                       Id id)

Constructs an instance of the CmLocalGroup 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 an object of the requested type.

fetchInstance

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

Retrieves an object of the CmLocalGroup class by the specified domain and 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 in null for the filter parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For details, see the description of the filter parameter.

Parameters:

domain - The Domain object to which this class instance 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:

An object of the requested type.

createInstance

public static CmLocalGroup createInstance(Domain domain,
                                          Id id)

Creates a new instance of the CmLocalGroup class based on the specified parameters.

Parameters:

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

id - The ID (GUID) assigned to the new class instance.

Returns:

An object reference to a new instance of this class.