public interface Function extends OsidRule
A Function
represents an authenticatable identity. Like
all OSID objects, a Function
is identified by its Id
and any persisted references should use the Id.
A
rule associated with the Function
specifies conditions that
can be supplied to authorization checks.
Modifier and Type | Method and Description |
---|---|
FunctionRecord |
getFunctionRecord(Type functionRecordType)
Gets the function record corresponding to the given
Function
record Type. |
Hierarchy |
getQualifierHierarchy()
Gets the qualifier hierarchy for this function.
|
Id |
getQualifierHierarchyId()
Gets the qualifier hierarchy
Id for this function. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getQualifierHierarchyId()
Id
for this function. Id
mandatory
- This method must be implemented. Hierarchy getQualifierHierarchy() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. FunctionRecord getFunctionRecord(Type functionRecordType) throws OperationFailedException
Function
record Type.
This method is used to retrieve an
object implementing the requested record. The
functionRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(functionRecordType)
is true
.functionRecordType
- the type of the record to retrieveNullArgumentException
- functionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(functionRecordType)
is false
mandatory
- This method must be implemented.