com.filenet.api.core

Class Factory.AddOn

java.lang.Object

com.filenet.api.core.Factory.AddOn

Enclosing class:

Factory

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

Method Summary

Methods

Modifier and Type	Method and Description
static AddOn	createInstance(Domain domain, Id id) Creates a new instance of the AddOn class based on the specified parameters.
static AddOn	fetchInstance(Domain domain, Id id, PropertyFilter filter) Retrieves an object of the AddOn class by the specified domain and ID.
static AddOn	fetchInstance(Domain domain, java.lang.String name, PropertyFilter filter) Retrieves an AddOn object based on the domain and ID specified.
static AddOn	fetchSupersedingInstance(Domain domain, Id id, PropertyFilter filter) Retrieves an object of the AddOn class by the specified domain and ID.
static AddOn	getInstance(Domain domain, Id id) Constructs an instance of the AddOn class by the specified domain and ID.
static AddOn	getInstance(Domain domain, java.lang.String name) Retrieves an instance of the AddOn 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

getInstance

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

Retrieves an instance of the AddOn 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 for which this instance is scoped.

name - The symbolic name of the class instance to retrieve.

Returns:

A reference to the AddOn object.

fetchInstance

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

Retrieves an AddOn object based on the domain and ID specified. 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 for which this instance is scoped.

name - The symbolic 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:

The AddOn instance retrieved.

createInstance

public static AddOn createInstance(Domain domain,
                   Id id)

Creates a new instance of the AddOn 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. This parameter must be non-null.

Returns:

An object reference to a new instance of this class.

fetchSupersedingInstance

public static AddOn fetchSupersedingInstance(Domain domain,
                             Id id,
                             PropertyFilter filter)

Retrieves an object of the AddOn class by the specified domain and ID. If the AddOn specified by id has been superseded by another AddOn, that AddOn (the superseding AddOn) is returned. This method always makes two round-trips 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. Note the object returned may not have the same ID if it corresponds to the superseding AddOn.

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.

getInstance

public static AddOn getInstance(Domain domain,
                Id id)

Constructs an instance of the AddOn 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 AddOn fetchInstance(Domain domain,
                  Id id,
                  PropertyFilter filter)

Retrieves an object of the AddOn 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.