|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ObjectSource
An interface for an object that provides fundamental object access services to Lighthouse components and applications.
Field Summary | |
---|---|
static java.lang.String |
code_id
|
static java.lang.String |
HIGH_VALUES
A sentinel value that represents the highest possible value of a sort key (e.g., OP_ORDER_BY). |
static java.lang.String |
OP_ALLOW_NOT_FOUND
An option that may be recognized by checkoutObject
to return null if it cannot find the specified object. |
static java.lang.String |
OP_ATTRIBUTES
The name of a query option used to specify search conditions. |
static java.lang.String |
OP_BLOCK_SIZE
The size of the block used when buffering query results. |
static java.lang.String |
OP_BUFFERED
The name of a query option used to requst result buffering. |
static java.lang.String |
OP_CONDITIONS
The name of a query option used to specify search conditions. |
static java.lang.String |
OP_END_BEFORE
The name of a query option that specifies a concatenated key value. |
static java.lang.String |
OP_FAST
An option that may be recognized by checkinObject
to perform the fastest possible checkin. |
static java.lang.String |
OP_FILTER
|
static java.lang.String |
OP_FORCE
An option that may be used with the checkinObject
method to disable any constraint checking that might ordinarily
be performed during the checkin. |
static java.lang.String |
OP_INTERNAL_CURRENT_PO
|
static java.lang.String |
OP_KEEP_LOCK
An option that may be recognized by checkinObject
to preserve the caller's logical lock on the specified object. |
static java.lang.String |
OP_MAX_ROWS
The name of a query option used to specify the maximum number of rows to return in a result. |
static java.lang.String |
OP_NO_CACHE
In some cases, the results of a listObjects call may be cached and reused. |
static java.lang.String |
OP_NO_RULE_DRIVEN_MEMBERS
The name of a query option used to specify that the query results should not include any rule driven members when a query includes the memberObjectGroup scoping attribute. |
static java.lang.String |
OP_ONLY_NAMES
Return only names (and IDs) in the query result. |
static java.lang.String |
OP_ORDER_BY
The name of a query option used to specify sorting of the result. |
static java.lang.String |
OP_START_AFTER
The name of a query option that specifies a concatenated key value. |
static java.lang.String |
OP_SUBJECT
The name of a query option used to specify the authorization filtering. |
static java.lang.String |
OP_SUBTYPES
A flag recognized by getObject and getObjectIfExists that will cause it to search repository subtypes of the given type. |
static java.lang.String |
OP_UNFILTERED_MAX_ROWS
The name of a query option used to specify the maximum number of unfiltered rows to return in a result. |
static java.lang.String |
OP_USER
The name of an option used with a number of PersistentObject access methods to specify the name of the Lighthouse user that is to be considered the performer of the request. |
Method Summary | |
---|---|
boolean |
breakLock(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Break a lock held on an object. |
WavesetResult |
checkinObject(PersistentObject obj,
java.util.Map options)
Store changes to an object and release the logical lock. |
WavesetResult |
checkinView(GenericObject view,
java.util.Map options)
Checkin a view. |
PersistentObject |
checkoutObject(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Checkout a persistent object for editing. |
GenericObject |
checkoutView(java.lang.String id,
java.util.Map options)
Checkout a view. |
WavesetResult |
commitView(GenericObject view,
java.util.Map options)
Commit a view. |
int |
countObjects(java.lang.Object type,
java.util.Map options)
Get a count of objects of a given type. |
GenericObject |
createView(java.lang.String id,
java.util.Map options)
Create a view. |
void |
deleteObject(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Delete an object. |
void |
deleteObjects(java.lang.Object type,
java.util.Map options)
Delete all objects matching certain conditions. |
WavesetResult |
deleteView(java.lang.String id,
java.util.Map options)
Delete the repository objects that are associated with the view id. |
com.waveset.object.ObjectCache |
getCache()
Get a handle to the object cache. |
com.waveset.object.Form |
getForm(GenericObject view,
java.util.Map options)
Get the form to be used with a view. |
com.waveset.object.LockInfo |
getLock(java.lang.Object type,
java.lang.String id)
Obtain current lock status. |
PersistentObject |
getObject(java.lang.Object type,
java.lang.String id)
Get a read-only copy of an object. |
PersistentObject |
getObject(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Get a read-only copy of an object. |
PersistentObject |
getObjectIfExists(java.lang.Object type,
java.lang.String id)
Get a read-only object copy of an object, but do not throw an exception if it does not exist. |
PersistentObject |
getObjectIfExists(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Get a read-only object copy of an object, but do not throw an exception if it does not exist. |
QueryResult |
getObjects(java.lang.Object type,
java.util.Map options)
Get a list of objects of a given type. |
GenericObject |
getSystemConfiguration()
Obtain the system configuration object. |
GenericObject |
getView(java.lang.String id,
java.util.Map options)
Get a view. |
QueryResult |
listObjects(java.lang.Object type,
java.util.Map options)
Get a list of summary attributes for objects of a given type. |
com.waveset.object.LockInfo |
lockObject(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Acquire a logical lock an object, without retrieving it. |
GenericObject |
refreshView(GenericObject view,
java.util.Map options)
Refresh a view. |
void |
renameObject(java.lang.Object type,
java.lang.String id,
java.lang.String newName,
java.util.Map options)
Rename an object. |
void |
unlockObject(java.lang.Object type,
java.lang.String id,
java.util.Map options)
Unlock a previously locked object. |
void |
unlockView(GenericObject view,
java.util.Map options)
Unlock a view. |
Field Detail |
---|
static final java.lang.String code_id
static final java.lang.String HIGH_VALUES
HIGH_VALUES
as the value of OP_END_BEFORE
should contain the items
with the highest OP_ORDER_BY
values.
static final java.lang.String OP_ALLOW_NOT_FOUND
checkoutObject
to return null
if it cannot find the specified object.
Otherwise, checkoutObject
throws ItemNotFound
if it cannot find the specified object.
static final java.lang.String OP_ATTRIBUTES
static final java.lang.String OP_BLOCK_SIZE
static final java.lang.String OP_BUFFERED
static final java.lang.String OP_CONDITIONS
static final java.lang.String OP_END_BEFORE
OP_ORDER_BY
values
are less than the set of values that this option specifies.
The value is expected to be a list of string values
that correspond positionally to the attribute names
that are specified as the value of OP_ORDER_BY
.
static final java.lang.String OP_FAST
checkinObject
to perform the fastest possible checkin. This may cause
certain constraint checking that is performed even with the OP_FORCE
option.
static final java.lang.String OP_FILTER
static final java.lang.String OP_FORCE
checkinObject
method to disable any constraint checking that might ordinarily
be performed during the checkin. This may be used to improve
the performance of the checkin in situations where the caller knows
that the object is valid. The ObjectSource may ignore this option.
When used with the deleteObject
method, it indicates
that inter-object delete constraints will not be checked. For
WSUser objects, it indicates that the WSUser may be deleted even
if the user has provisioned resource accounts.
static final java.lang.String OP_INTERNAL_CURRENT_PO
static final java.lang.String OP_KEEP_LOCK
checkinObject
to preserve the caller's logical lock on the specified object.
Otherwise, checkinObject
releases any logical lock
after updating the object.
static final java.lang.String OP_MAX_ROWS
static final java.lang.String OP_NO_CACHE
This option will also be recognized by the PersistentObject access methods such as getObject and getObjectIfExists to avoid the object cache. The checkoutObject method will always bypass the cache when obtaining a lock.
static final java.lang.String OP_NO_RULE_DRIVEN_MEMBERS
static final java.lang.String OP_ONLY_NAMES
static final java.lang.String OP_ORDER_BY
static final java.lang.String OP_START_AFTER
OP_ORDER_BY
values
are greater than the set of values that this option specifies.
The value is expected to be a list of string values
that correspond positionally to the attribute names
that are specified as the value of OP_ORDER_BY
.
static final java.lang.String OP_SUBJECT
static final java.lang.String OP_SUBTYPES
static final java.lang.String OP_UNFILTERED_MAX_ROWS
static final java.lang.String OP_USER
The ObjectSource is not required to support this option; if it does not, then it will silently ignore the option.
Method Detail |
---|
boolean breakLock(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.util.WavesetException
There is no guarentee a lock will be broken, you normally must have authority over the user that is currently holding the lock.
The OP_USER
option may be used to specify the
name of the user considered to be breaking the lock.
com.waveset.exception.ItemNotFound
com.waveset.util.WavesetException
WavesetResult checkinObject(PersistentObject obj, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.ItemNotLocked, com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
The OP_USER
option may be used to specify the
name of the user considered to be checking in the object.
The OP_FORCE
option may be passed to inhibit
any constraint checking that would ordinarilly be done
prior to storage. This is normally
off, but since constraint checking can be expensive, there may
be performance reasons for turning it on if you can ensure that
the object is correct.
The OP_KEEP_LOCK
option may be passed
to preserve the caller's logical lock on the specified object.
Otherwise, this method releases any lock after updating the object.
com.waveset.exception.ItemNotFound
com.waveset.exception.ItemNotLocked
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
WavesetResult checkinView(GenericObject view, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
PersistentObject checkoutObject(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
It is usually more efficient to call checkoutObject
rather
than make individual calls to lockObject
and getObject
The OP_USER
option may be used to specify the
name of the user considered to be checking out the object.
The OP_ALLOW_NOT_FOUND
option may be passed
to return null
if cannot find the specified object.
Otherwise, this method throws ItemNotFound
.
com.waveset.exception.ItemNotFound
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
GenericObject checkoutView(java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
WavesetResult commitView(GenericObject view, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
int countObjects(java.lang.Object type, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
GenericObject createView(java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
void deleteObject(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
The OP_USER
option may be used to specify the
name of the user considered to be deleting in the object.
The OP_FORCE
option may be passed to inhibit
any constraint checking that would ordinarilly be done.
This may be used to delete a WSUser object that has provisioned
resource accounts, normally a WSUser cannot be deleted until
it has been fully deprovisioned.
com.waveset.exception.ItemNotFound
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
void deleteObjects(java.lang.Object type, java.util.Map options) throws com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
WavesetResult deleteView(java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
com.waveset.object.ObjectCache getCache()
com.waveset.object.Form getForm(GenericObject view, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
com.waveset.object.LockInfo getLock(java.lang.Object type, java.lang.String id) throws com.waveset.exception.ItemNotFound, com.waveset.util.WavesetException
com.waveset.exception.ItemNotFound
com.waveset.util.WavesetException
PersistentObject getObject(java.lang.Object type, java.lang.String id) throws com.waveset.util.WavesetException, com.waveset.exception.ItemNotFound
checkoutObject
method.
com.waveset.util.WavesetException
com.waveset.exception.ItemNotFound
PersistentObject getObject(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException, com.waveset.exception.ItemNotFound
com.waveset.util.WavesetException
com.waveset.exception.ItemNotFound
PersistentObject getObjectIfExists(java.lang.Object type, java.lang.String id) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
PersistentObject getObjectIfExists(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
QueryResult getObjects(java.lang.Object type, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
GenericObject getSystemConfiguration() throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
GenericObject getView(java.lang.String id, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
QueryResult listObjects(java.lang.Object type, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
com.waveset.object.LockInfo lockObject(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
The OP_USER
option may be used to specify the
name of the user considered to be acquiring the lock.
com.waveset.exception.ItemNotFound
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
GenericObject refreshView(GenericObject view, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
void renameObject(java.lang.Object type, java.lang.String id, java.lang.String newName, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.LockedByAnother, com.waveset.exception.AlreadyExists, com.waveset.util.WavesetException
The object must unlocked, or locked by the current user. It will be implicitly locked to perform the rename.
The OP_USER
option may be used to specify the
name of the user considered to be renaming the object.
com.waveset.exception.ItemNotFound
com.waveset.exception.LockedByAnother
com.waveset.exception.AlreadyExists
com.waveset.util.WavesetException
void unlockObject(java.lang.Object type, java.lang.String id, java.util.Map options) throws com.waveset.exception.ItemNotFound, com.waveset.exception.ItemNotLocked, com.waveset.exception.LockedByAnother, com.waveset.util.WavesetException
The OP_USER
option may be used to specify the
name of the user considered to be releasing the lock.
com.waveset.exception.ItemNotFound
com.waveset.exception.ItemNotLocked
com.waveset.exception.LockedByAnother
com.waveset.util.WavesetException
void unlockView(GenericObject view, java.util.Map options) throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |