arlut.csd.ganymede
Interface perm_field

All Superinterfaces:

db_field, java.rmi.Remote

All Known Implementing Classes:

PermissionMatrixDBField

public interface perm_field

extends db_field

Client-side remote interface to the PermissionMatrixDBField class.

Method Summary

PermMatrix	getMatrix() Return a serializable, read-only copy of this field's permission matrix
PermEntry	getPerm(Base base) Returns a PermEntry object representing this PermMatrix's permissions on the base <base>
PermEntry	getPerm(Base base, BaseField field) Returns a PermEntry object representing this PermMatrix's permissions on the field <field> in base <base>
PermEntry	getPerm(short baseID) Returns a PermEntry object representing this PermMatrix's permissions on the base <base>
PermEntry	getPerm(short baseID, short fieldID) Returns a PermEntry object representing this PermMatrix's permissions on the field <field> in base <base>
PermMatrix	getTemplateMatrix() Return a serializable, read-only copy of the maximum permissions that can be set for this field's permission matrix.
ReturnVal	resetPerms() Resets the permissions in this PermissionMatrixDBField to the empty set.
ReturnVal	setFieldPerms(short baseID, PermEntry entry, boolean includeBuiltins) Sets the permission entry for all fields in base <baseID> to PermEntry <entry>
ReturnVal	setPerm(Base base, BaseField field, PermEntry entry) Sets the permission entry for this matrix for base <baseID>, field <fieldID> to PermEntry <entry>.
ReturnVal	setPerm(Base base, PermEntry entry) Sets the permission entry for this matrix for base <baseID> to PermEntry <entry>
ReturnVal	setPerm(short baseID, PermEntry entry) Sets the permission entry for this matrix for base <baseID> to PermEntry <entry>
ReturnVal	setPerm(short baseID, short fieldID, PermEntry entry) Sets the permission entry for this matrix for base <baseID>, field <fieldID> to PermEntry <entry>.

Methods inherited from interface arlut.csd.ganymede.db_field

addElement, addElements, containsElement, deleteAllElements, deleteElement, deleteElement, deleteElements, getComment, getElement, getEncodingString, getFieldInfo, getFieldTemplate, getID, getName, getType, getTypeDesc, getValue, getValues, getValueString, isBuiltIn, isDefined, isEditable, isEditInPlace, isVector, isVisible, setElement, setValue, size

Method Detail

getMatrix

public PermMatrix getMatrix()
                     throws java.rmi.RemoteException

Return a serializable, read-only copy of this field's permission matrix

getTemplateMatrix

public PermMatrix getTemplateMatrix()
                             throws java.rmi.RemoteException

Return a serializable, read-only copy of the maximum permissions that can be set for this field's permission matrix. This matrix is drawn from the union of delegatable roles that the client's adminPersona is a member of.

This method will return null if this perm_field is not associated with an object that is being edited, or if the client is logged into the server as supergash.

getPerm

public PermEntry getPerm(short baseID,
                         short fieldID)
                  throws java.rmi.RemoteException

Returns a PermEntry object representing this PermMatrix's permissions on the field <field> in base <base>

If this permissions field has no explicit record for the specified field, the default permissions value for this base will be returned if defined, else getPerm() will return null.

See Also:

PermEntry

getPerm

public PermEntry getPerm(short baseID)
                  throws java.rmi.RemoteException

Returns a PermEntry object representing this PermMatrix's permissions on the base <base>

See Also:

PermEntry

getPerm

public PermEntry getPerm(Base base,
                         BaseField field)
                  throws java.rmi.RemoteException

Returns a PermEntry object representing this PermMatrix's permissions on the field <field> in base <base>

If this permissions field has no explicit record for the specified field, the default permissions value for this base will be returned if defined, else getPerm() will return null.

See Also:

PermEntry

getPerm

public PermEntry getPerm(Base base)
                  throws java.rmi.RemoteException

Returns a PermEntry object representing this PermMatrix's permissions on the base <base>

See Also:

PermEntry

resetPerms

public ReturnVal resetPerms()
                     throws java.rmi.RemoteException

Resets the permissions in this PermissionMatrixDBField to the empty set. Used by non-interactive clients to reset the Permission Matrix to a known state before setting permissions.

Returns null on success, or a failure-coded ReturnVal on permissions failure.

setPerm

public ReturnVal setPerm(short baseID,
                         short fieldID,
                         PermEntry entry)
                  throws java.rmi.RemoteException

Sets the permission entry for this matrix for base <baseID>, field <fieldID> to PermEntry <entry>.

This operation will fail if this permission matrix is not associated with a currently checked-out-for-editing PermissionMatrixDBField.

See Also:

PermEntry

setPerm

public ReturnVal setPerm(short baseID,
                         PermEntry entry)
                  throws java.rmi.RemoteException

Sets the permission entry for this matrix for base <baseID> to PermEntry <entry>

This operation will fail if this permission matrix is not associated with a currently checked-out-for-editing PermissionMatrixDBField.

See Also:

PermEntry

setPerm

public ReturnVal setPerm(Base base,
                         BaseField field,
                         PermEntry entry)
                  throws java.rmi.RemoteException

Sets the permission entry for this matrix for base <baseID>, field <fieldID> to PermEntry <entry>.

This operation will fail if this permission matrix is not associated with a currently checked-out-for-editing PermissionMatrixDBField.

See Also:

PermEntry

setPerm

public ReturnVal setPerm(Base base,
                         PermEntry entry)
                  throws java.rmi.RemoteException

Sets the permission entry for this matrix for base <baseID> to PermEntry <entry>

This operation will fail if this permission matrix is not associated with a currently checked-out-for-editing PermissionMatrixDBField.

See Also:

PermEntry

setFieldPerms

public ReturnVal setFieldPerms(short baseID,
                               PermEntry entry,
                               boolean includeBuiltins)
                        throws java.rmi.RemoteException

Sets the permission entry for all fields in base <baseID> to PermEntry <entry>

This operation will fail if this PermissionMatrixDBField is not editable.

Parameters:

includeBuiltins - if true, this will set the permissions for the built-in fields to entry as well as the custom fields.