public interface ParameterProcessor extends OsidProcessor
A ParameterProcessor
describes the rules for processing
parameters.
Modifier and Type | Method and Description |
---|---|
ParameterProcessorRecord |
getParameterProcessorRecord(Type parameterProcessorRecordType)
Gets the parameter processor record corresponding to the given
ParameterProcessor record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
ParameterProcessorRecord getParameterProcessorRecord(Type parameterProcessorRecordType) throws OperationFailedException
ParameterProcessor
record Type.
This method is
used to retrieve an object implementing the requested record. The
parameterProcessorRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(parameterProcessorRecordType)
is true
.parameterProcessorRecordType
- the type of parameter processor
record to retrieveNullArgumentException
-
parameterProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterProcessorRecordType)
is
false
mandatory
- This method must be implemented.