public static class Factory.ObjectStore
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static ObjectStore |
createInstance(Domain domain,
java.lang.String[] admins,
java.lang.String[] users)
Creates a new instance of the
ObjectStore class based on the specified parameters. |
static ObjectStore |
createInstance(Domain domain,
java.lang.String[] admins,
java.lang.String[] users,
java.lang.String schemaScript)
Creates a new instance of the
ObjectStore class based on the specified parameters. |
static ObjectStore |
fetchInstance(Domain domain,
Id id,
PropertyFilter filter)
Retrieves an object of the
ObjectStore class
by the specified domain and ID. |
static ObjectStore |
fetchInstance(Domain domain,
java.lang.String name,
PropertyFilter filter)
Retrieves the specified object from this
ObjectStore object. |
static ObjectStore |
getInstance(Domain domain,
Id id)
Constructs an instance of the
ObjectStore class by the specified domain and ID. |
static ObjectStore |
getInstance(Domain domain,
java.lang.String name)
Retrieves an instance of the
ObjectStore class by the specified domain and ID. |
public static ObjectStore getInstance(Domain domain, java.lang.String name)
ObjectStore
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.domain
- The FileNet P8 domain to which this object is scoped.name
- The symbolic name of the class instance to retrieve.ObjectStore
object.public static ObjectStore fetchInstance(Domain domain, java.lang.String name, PropertyFilter filter)
ObjectStore
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.domain
- The FileNet P8 domain to which this object 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.ObjectStore
.public static ObjectStore createInstance(Domain domain, java.lang.String[] admins, java.lang.String[] users)
ObjectStore
class based on the specified parameters.
Before calling the save
method, you must also set additional properties for the object store.
DisplayName, SymbolicName, JNDIDataSource, and JNDIXADataSource are required
at a minimum. Use property accessor methods (for example, set_DisplayName) to set the property values.
The ObjectStore
object is created when the returned instance is saved.
Note: Provide values for the admins
and users
parameters.
Otherwise, Content Engine will derive default values based on permissions on the P8 Domain, and these values might not be correct for your environment.
See Object store access rights.
domain
- The FileNet P8 domain to which the new instance is scoped.admins
- An array of strings representing the administrative users and/or groups
who can access this object store; for example, "Domain Admins".users
- An array of strings representing the security principal names of the users and/or groups
who can access this object store; for example, "Domain Users".ObjectStore
.public static ObjectStore createInstance(Domain domain, java.lang.String[] admins, java.lang.String[] users, java.lang.String schemaScript)
ObjectStore
class based on the specified parameters.
Before calling the save
method, you must also set additional properties for the object store.
DisplayName, SymbolicName, JNDIDataSource, and JNDIXADataSource are required
at a minimum. Use property accessor methods (for example, set_DisplayName) to set the property values.
The ObjectStore
object is created when the returned instance is saved.
This form of the createInstance
method allows you to submit a custom schema script that
the server will use during object store creation. Typical modifications to the script include the
distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces.
However, note that making changes to the names and structures of the tables, indexes, and columns is not
supported; such changes will lead to system failures.
Note: It is a best practice to provide values for the admins
and users
parameters.
Otherwise, Content Engine will derive a default value based on permissions on the P8 Domain, and this value might not be correct for your environment.
See Object store access rights.
domain
- The FileNet P8 domain to which the new instance is scoped.admins
- An array of strings representing the administrative users and/or groups
who can access this object store; for example, "Domain Admins".users
- An array of strings representing the security principal names of the users and/or groups
who can access this object store; for example, "Domain Users".schemaScript
- A string containing a customized schema script specifying the object store's database
schema. This script should be derived from the appropriate Domain.ObjectStoreSchemaXXX
property, where
XXX is the database type (DB2, MSSQL, or Oracle), and must contain the correct version information.ObjectStore
.public static ObjectStore getInstance(Domain domain, Id id)
ObjectStore
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.domain
- The FileNet P8 domain to which the new instance is scoped.id
- The ID (GUID) of the object to retrieve.public static ObjectStore fetchInstance(Domain domain, Id id, PropertyFilter filter)
ObjectStore
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.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.© Copyright IBM Corporation 2006, 2015. All rights reserved.