Interface Block
- All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
A Block . A Block maps to a set of Issues and
whose impact is interpreted outside this service.
-
Method Summary
Modifier and TypeMethodDescriptiongetBlockRecord(Type blockRecordType) Gets the block record corresponding to the givenBlockrecordType.This method is used to retrieve an object implementing the requested record.Gets theIdsof the issues.Gets the issues.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.
-
Method Details
-
getIssueIds
IdList getIssueIds()Gets theIdsof the issues.- Returns:
- the issue
Ids - Compliance:
mandatory- This method must be implemented.
-
getIssues
Gets the issues.- Returns:
- the issues
- Throws:
OperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getBlockRecord
BlockRecord getBlockRecord(Type blockRecordType) throws OperationFailedException, PermissionDeniedException Gets the block record corresponding to the givenBlockrecordType.This method is used to retrieve an object implementing the requested record. TheblockRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(blockRecordType)istrue.- Parameters:
blockRecordType- the type of block record to retrieve- Returns:
- the block record
- Throws:
NullArgumentException-blockRecordTypeisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnsupportedException-hasRecordType(blockRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-