public interface Site extends OsidObject
A Site
represents an installation location.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getPath()
Gets the path to this site.
|
SiteRecord |
getSiteRecord(Type siteRecordType)
Gets the site record corresponding to the given
Site
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
java.lang.String getPath()
mandatory
- This method must be implemented. SiteRecord getSiteRecord(Type siteRecordType) throws OperationFailedException
Site
record Type.
This method is used to retrieve an object
implementing the requested record. The siteRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(siteRecordType)
is true
.siteRecordType
- the type of the record to retrieveNullArgumentException
- siteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(siteRecordType)
is false
mandatory
- This method must be implemented.