| org.sakaiproject.citation.api.Citation
| Citation | | public interface Citation (Code) | | |
| addCustomUrl | | public void addCustomUrl(String label, String url)(Code) | |
Parameters:
label -
Parameters:
url - A unique identifier for the URL and its label. |
| addPropertyValue | | public void addPropertyValue(String name, Object value)(Code) | |
Parameters:
name -
Parameters:
value - |
| getCitationProperties | | public Map getCitationProperties()(Code) | | Access a mapping of name-value pairs for various bibliographic information about the resource.
Ideally, the names will be expressed as URIs for standard tags representing nuggets of bibliographic metadata.
Values will be strings in formats specified by the standards defining the property names. For example if the
name is a URI referencing a standard format for a "publication_date" and the standard indicates that the value
should be expressed as in xs:date format, the value should be expressed as a string representation of xs:date.
The mapping of name-value pairs. The mapping may be empty, but it should never be null. |
| getCitationProperty | | public Object getCitationProperty(String name)(Code) | | Access a representation of the value(s) of a named property. If the property is multivalued,
the object returned will be a (possibly empty) java.util.List. Otherwise it will be an Object
of a type appropriate for the named property (usually a String or a Date). The value(s)
must be of a type for which toString() is defined and returns a reasonable representation
for use in a textual display of the citation.
Parameters:
name - The name of the property for which a value is to be returned. A representation of the value(s) of the named property. May be an empty String ("") if the property is not defined. |
| getCustomUrlIds | | public List getCustomUrlIds()(Code) | | |
| getDisplayName | | public String getDisplayName()(Code) | | Access the brief "title" of the resource, which can be used to display the item in a list of items.
The display name. |
| getOpenurlParameters | | public String getOpenurlParameters()(Code) | | |
| getSchema | | public Schema getSchema()(Code) | | Access the schema for the Citation
th |
| hasCustomUrls | | public boolean hasCustomUrls()(Code) | | |
| hasPropertyValue | | public boolean hasPropertyValue(String fieldId)(Code) | | |
| isAdded | | public boolean isAdded()(Code) | | |
| isMultivalued | | public boolean isMultivalued(String fieldId)(Code) | |
Parameters:
fieldId - |
| listCitationProperties | | public List listCitationProperties()(Code) | | Access a list of names of citation properties defined for this resource.
The list of property names. The list may be empty, but it should never be null. |
| setAdded | | public void setAdded(boolean added)(Code) | |
Parameters:
added - |
| setCitationProperty | | public void setCitationProperty(String name, Object value)(Code) | |
Parameters:
name -
Parameters:
value - |
| setDisplayName | | public void setDisplayName(String name)(Code) | |
Parameters:
name - |
| setSchema | | public void setSchema(Schema schema)(Code) | |
Parameters:
schema - |
| updateCitationProperty | | public void updateCitationProperty(String name, List values)(Code) | | Replaces the current value(s) of a citation property. If the field identified by the parameter "name"
is multivalued, the values in the list parameter "values" replace the current values. If the field is
single valued, the first value in the list "values" replaces the current value. In either case, if the
values parameter is null or empty, all current values are removed and no new values are added.
Parameters:
name -
Parameters:
values - |
| updateCustomUrl | | public void updateCustomUrl(String urlid, String label, String url)(Code) | |
Parameters:
urlid -
Parameters:
label -
Parameters:
url - |
|
|