|
| |
|
| org.sakaiproject.entity.api.ResourceProperties
All known Subclasses: org.sakaiproject.util.BaseResourceProperties,
| ResourceProperties | | public interface ResourceProperties extends Serializable(Code) | |
ResourceProperties models the open-ended propeties of a Sakai Entity.
|
| FILE_TYPE | | final static String FILE_TYPE(Code) | | Used to find non structured object ContentResources (files, url's, etc.)
|
| NEW_ASSIGNMENT_CHECK_ADD_DUE_DATE | | final static String NEW_ASSIGNMENT_CHECK_ADD_DUE_DATE(Code) | | Property for whether an assignment's due date will be added into schedule as an event(user settable). [String]
|
| NEW_ASSIGNMENT_CHECK_AUTO_ANNOUNCE | | final static String NEW_ASSIGNMENT_CHECK_AUTO_ANNOUNCE(Code) | | Property for whether an assignment's open date will be announced (user settable). [String]
|
| PROP_ASSIGNMENT_DELETED | | final static String PROP_ASSIGNMENT_DELETED(Code) | | Property for assignment been deleted status(user settable) [String]
|
| PROP_ASSIGNMENT_DUEDATE_CALENDAR_EVENT_ID | | final static String PROP_ASSIGNMENT_DUEDATE_CALENDAR_EVENT_ID(Code) | | Property for calendar event associated with an assignment's due date (user settable). [String]
|
| PROP_ASSIGNMENT_OPENDATE_ANNOUNCEMENT_MESSAGE_ID | | final static String PROP_ASSIGNMENT_OPENDATE_ANNOUNCEMENT_MESSAGE_ID(Code) | | Property for announcement message id associated with an assignment's open date (user settable). [String]
|
| PROP_CALENDAR_EVENT_FIELDS | | final static String PROP_CALENDAR_EVENT_FIELDS(Code) | | Property for calendar event extra fields (user settable). [String]
|
| PROP_CALENDAR_LOCATION | | final static String PROP_CALENDAR_LOCATION(Code) | | Property for calendar event location (user settable). [String]
|
| PROP_CALENDAR_TYPE | | final static String PROP_CALENDAR_TYPE(Code) | | Property for calendar event types (user settable). [String]
|
| PROP_CHANNEL_ENABLED | | final static String PROP_CHANNEL_ENABLED(Code) | | Property for a message channel indicating if the channel is 'enabled' (user settable) [Boolean]
|
| PROP_CHAT_ROOM | | final static String PROP_CHAT_ROOM(Code) | | Property to associate a chat message with a chat room (user settable). [String]
|
| PROP_COLLECTION_BODY_QUOTA | | final static String PROP_COLLECTION_BODY_QUOTA(Code) | | Property that holds a ContentHosting collection body bytes quota, in K (user settable). [long]
|
| PROP_CONTENT_ENCODING | | final static String PROP_CONTENT_ENCODING(Code) | | The encoding of the resource - UTF-8 or ISO-8559-1 for example
|
| PROP_CONTENT_LENGTH | | final static String PROP_CONTENT_LENGTH(Code) | | Property for the content length (live, from DAV:). [Long]
|
| PROP_CONTENT_PRIORITY | | final static String PROP_CONTENT_PRIORITY(Code) | | Property name on a ContentEntity indicating its rank if a custom priority sort is used.
|
| PROP_CONTENT_TYPE | | final static String PROP_CONTENT_TYPE(Code) | | Property for the content type (live, from DAV:). [MIME type string]
|
| PROP_COPYRIGHT | | final static String PROP_COPYRIGHT(Code) | | Property for the copyright attribution (user settable). [String]
|
| PROP_COPYRIGHT_ALERT | | final static String PROP_COPYRIGHT_ALERT(Code) | | Property for the copyright alert attribution (user settable). [String]
|
| PROP_COPYRIGHT_CHOICE | | final static String PROP_COPYRIGHT_CHOICE(Code) | | Property for the copyright choice attribution (user settable). [String]
|
| PROP_CREATION_DATE | | final static String PROP_CREATION_DATE(Code) | | Property for creation (upload) date (live, from DAV:). [Time]
|
| PROP_CREATOR | | final static String PROP_CREATOR(Code) | | Property for resource creator (uploader) (automatic). [user id string]
|
| PROP_DESCRIPTION | | final static String PROP_DESCRIPTION(Code) | | Property for long open description (user settable). [String]
|
| PROP_DISCUSSION_CATEGORIES | | final static String PROP_DISCUSSION_CATEGORIES(Code) | | Property for the channel to categories names inside a discussion channel (user settable). [String]
|
| PROP_DISPLAY_NAME | | final static String PROP_DISPLAY_NAME(Code) | | Property for the display name (description) (dead, from DAV:). [String]
|
| PROP_HAS_CUSTOM_SORT | | final public static String PROP_HAS_CUSTOM_SORT(Code) | | Property name on a ContentCollection indicating that a custom priority sort is to be used.
|
| PROP_IS_COLLECTION | | final static String PROP_IS_COLLECTION(Code) | | Property that distinguishes a collection from a non-collection resource (automatic). [Boolean]
|
| PROP_MAIL_CHANNEL_OPEN | | final static String PROP_MAIL_CHANNEL_OPEN(Code) | | Property for a message channel indicating if the channel is 'enabled' (user settable) [Boolean]
|
| PROP_MODIFIED_BY | | final static String PROP_MODIFIED_BY(Code) | | Property for resource last one to modify (automatic). [user id string]
|
| PROP_MODIFIED_DATE | | final static String PROP_MODIFIED_DATE(Code) | | Property for the last modified date (live, from DAV:, set when anything changes). [Time]
|
| PROP_ORIGINAL_FILENAME | | final static String PROP_ORIGINAL_FILENAME(Code) | | Property for the original filename (automatic). [String]
|
| PROP_PUBVIEW | | final static String PROP_PUBVIEW(Code) | | Property indicating viewable (manual). [Boolean]
|
| PROP_REPLY_STYLE | | final static String PROP_REPLY_STYLE(Code) | | Property that discussion reply message style is star or thread (automatic) [String]
|
| PROP_RESOURCE_TYPE | | final static String PROP_RESOURCE_TYPE(Code) | | Property name on a ContentEntity indicating the ResourceType that defines its properties.
|
| PROP_SITE_EMAIL_ARCHIVE | | final static String PROP_SITE_EMAIL_ARCHIVE(Code) | | Property for a site indicating if email archiveing is enabled for the site (user settable) [Boolean]
|
| PROP_SITE_EMAIL_NOTIFICATION_ID | | final static String PROP_SITE_EMAIL_NOTIFICATION_ID(Code) | | Property for a site storing the email notification id associated with the site's mailbox (user settable) [String]
|
| PROP_STRUCTOBJ_TYPE | | final static String PROP_STRUCTOBJ_TYPE(Code) | | Property for "object type" of a structured artifact
|
| PROP_SUBMISSION_PREVIOUS_FEEDBACK_COMMENT | | final static String PROP_SUBMISSION_PREVIOUS_FEEDBACK_COMMENT(Code) | | Property for assignment submission's previous feedback comment (user settable). [String]
|
| PROP_SUBMISSION_PREVIOUS_FEEDBACK_TEXT | | final static String PROP_SUBMISSION_PREVIOUS_FEEDBACK_TEXT(Code) | | Property for assignment submission's previous inline feedback text (user settable). [String]
|
| PROP_SUBMISSION_PREVIOUS_GRADES | | final static String PROP_SUBMISSION_PREVIOUS_GRADES(Code) | | Property for assignment submission's previous grade (user settable). [String]
|
| PROP_SUBMISSION_SCALED_PREVIOUS_GRADES | | final static String PROP_SUBMISSION_SCALED_PREVIOUS_GRADES(Code) | | Property for assignment submission's scaled previous grade (user settable). [String]
|
| PROP_TO | | final static String PROP_TO(Code) | | Property to target a message to a specific user (user settable). [User]
|
| PROP_TOOL_CATEGORY | | final static String PROP_TOOL_CATEGORY(Code) | | Property for a ToolRegistration, category of the tool (user settable) [String] %%% list desired -ggolden
|
| PROP_TOOL_DESCRIPTION | | final static String PROP_TOOL_DESCRIPTION(Code) | | Property for a ToolRegistration, description of the tool (user settable) [String]
|
| PROP_TOOL_TITLE | | final static String PROP_TOOL_TITLE(Code) | | Property for a ToolRegistration, the title of the tool (user settable) [String]
|
| addAll | | void addAll(ResourceProperties other)(Code) | | Add all the properties from the other ResourceProperties object.
Parameters:
other - The ResourceProperties to add. |
| addAll | | void addAll(Properties props)(Code) | | Add all the properties from the Properties object.
Parameters:
props - The Properties to add. |
| addProperty | | void addProperty(String name, String value)(Code) | | Add a single valued property.
Parameters:
name - The property name.
Parameters:
value - The property value. |
| addPropertyToList | | void addPropertyToList(String name, String value)(Code) | | Add a value to a multi-valued property.
Parameters:
name - The property name.
Parameters:
value - The property value. |
| clear | | void clear()(Code) | | Remove all properties.
|
| get | | Object get(String name)(Code) | | Access a named property; as a String if it's single valued, or a List of (String) if it's multi-valued (or null if it's not defined).
Parameters:
name - The property name. the property value, or null if not found. |
| getNamePropAssignmentDeleted | | String getNamePropAssignmentDeleted()(Code) | | Get the static String of PROP_ASSIGNMENT_DELETED
The static String of PROP_ASSIGNMENT_DELETED |
| getNamePropCalendarLocation | | String getNamePropCalendarLocation()(Code) | | Get the static String of PROP_CALENDAR_LOCATION
The static String of PROP_CALENDAR_LOCATION |
| getNamePropCalendarType | | String getNamePropCalendarType()(Code) | | Get the static String of PROP_CALENDAR_TYPE
The static String of PROP_CALENDAR_TYPE |
| getNamePropChatRoom | | String getNamePropChatRoom()(Code) | | Get the static String of PROP_CHAT_ROOM
The static String of PROP_CHAT_ROOM |
| getNamePropCollectionBodyQuota | | String getNamePropCollectionBodyQuota()(Code) | | Get the static String of PROP_COLLECTION_BODY_QUOTA
The static String of PROP_COLLECTION_BODY_QUOTA |
| getNamePropContentLength | | String getNamePropContentLength()(Code) | | Get the static String of PROP_CONTENT_LENGTH
The static String of PROP_CONTENT_LENGTH |
| getNamePropContentType | | String getNamePropContentType()(Code) | | Get the static String of PROP_CONTENT_TYPE
The static String of PROP_CONTENT_TYPE |
| getNamePropCopyright | | String getNamePropCopyright()(Code) | | Get the static String of PROP_COPYRIGHT
The static String of PROP_COPYRIGHT |
| getNamePropCopyrightAlert | | String getNamePropCopyrightAlert()(Code) | | Get the static String of PROP_COPYRIGHT_ALERT
The static String of PROP_COPYRIGHT_ALERT |
| getNamePropCopyrightChoice | | String getNamePropCopyrightChoice()(Code) | | Get the static String of PROP_COPYRIGHT_CHOICE
The static String of PROP_COPYRIGHT_CHOICE |
| getNamePropCreationDate | | String getNamePropCreationDate()(Code) | | Get the static String of PROP_CREATION_DATE
The static String of PROP_CREATION_DATE |
| getNamePropCreator | | String getNamePropCreator()(Code) | | Get the static String of PROP_CREATOR
The static String of PROP_CREATOR |
| getNamePropDescription | | String getNamePropDescription()(Code) | | Get the static String of PROP_DESCRIPTION
The static String of PROP_DESCRIPTION |
| getNamePropDisplayName | | String getNamePropDisplayName()(Code) | | Get the static String of PROP_DISPLAY_NAME
The static String of PROP_DISPLAY_NAME |
| getNamePropIsCollection | | String getNamePropIsCollection()(Code) | | Get the static String of PROP_IS_COLLECTION
The static String of PROP_IS_COLLECTION |
| getNamePropModifiedBy | | String getNamePropModifiedBy()(Code) | | Get the static String of PROP_MODIFIED_BY
The static String of PROP_MODIFIED_BY |
| getNamePropModifiedDate | | String getNamePropModifiedDate()(Code) | | Get the static String of PROP_MODIFIED_DATE
The static String of PROP_MODIFIED_DATE |
| getNamePropNewAssignmentCheckAddDueDate | | String getNamePropNewAssignmentCheckAddDueDate()(Code) | | Get the static String of NEW_ASSIGNMENT_CHECK_ADD_DUE_DATE
The static String of NEW_ASSIGNMENT_CHECK_ADD_DUE_DATE |
| getNamePropNewAssignmentCheckAutoAnnounce | | String getNamePropNewAssignmentCheckAutoAnnounce()(Code) | | Get the static String of NEW_ASSIGNMENT_CHECK_AUTO_ANNOUNCE
The static String of NEW_ASSIGNMENT_CHECK_AUTO_ANNOUNCE |
| getNamePropReplyStyle | | String getNamePropReplyStyle()(Code) | | Get the static String of PROP_REPLY_STYLE
The static String of PROP_REPLY_STYLE |
| getNamePropStructObjType | | String getNamePropStructObjType()(Code) | | Get the static String of PROP_STRUCTOBJ_TYPE
The static String of PROP_STRUCTOBJ_TYPE |
| getNamePropSubmissionPreviousFeedbackComment | | String getNamePropSubmissionPreviousFeedbackComment()(Code) | | Get the static String of PROP_SUBMISSION_PREVIOUS_FEEDBACK_COMMENT
The static String of PROP_SUBMISSION_PREVIOUS_FEEDBACK_COMMENT |
| getNamePropSubmissionPreviousFeedbackText | | String getNamePropSubmissionPreviousFeedbackText()(Code) | | Get the static String of PROP_SUBMISSION_PREVIOUS_FEEDBACK_TEXT
The static String of PROP_SUBMISSION_PREVIOUS_FEEDBACK_TEXT |
| getNamePropSubmissionPreviousGrades | | String getNamePropSubmissionPreviousGrades()(Code) | | Get the static String of PROP_SUBMISSION_PREVIOUS_GRADES
The static String of PROP_SUBMISSION_PREVIOUS_GRADES |
| getNamePropSubmissionScaledPreviousGrades | | String getNamePropSubmissionScaledPreviousGrades()(Code) | | Get the static String of PROP_SUBMISSION_SCALED_PREVIOUS_GRADES
The static String of PROP_SUBMISSION_SCALED_PREVIOUS_GRADES |
| getNamePropTo | | String getNamePropTo()(Code) | | Get the static String of PROP_TO
The static String of PROP_TO |
| getProperty | | String getProperty(String name)(Code) | | Access a named property as a string (won't find multi-valued ones.)
Parameters:
name - The property name. the property value, or null if not found. |
| getPropertyFormatted | | String getPropertyFormatted(String name)(Code) | | Access a named property as a properly formatted string.
Parameters:
name - The property name. the property value, or an empty string if not found. |
| getPropertyList | | List getPropertyList(String name)(Code) | | Access a named property as a List of (String), good for single or multi-valued properties.
Parameters:
name - The property name. the property value, or null if not found. |
| getPropertyNames | | Iterator getPropertyNames()(Code) | | Access an iterator on the names of the defined properties (Strings).
An iterator on the names of the defined properties (Strings) (may be empty). |
| getTypeUrl | | String getTypeUrl()(Code) | | Get the static String of TYPE_URL
The static String of TYPE_URL |
| isLiveProperty | | boolean isLiveProperty(String name)(Code) | | Check if a named property is a live one (auto updated).
Parameters:
name - The property name. True if the property is a live one, false if not. |
| removeProperty | | void removeProperty(String name)(Code) | | Remove a property.
Parameters:
name - The property name. |
| set | | void set(ResourceProperties other)(Code) | | Take all values from this object.
Parameters:
other - The ResourceProperties object to take values from. |
| toXml | | Element toXml(Document doc, Stack stack)(Code) | | Serialize the resource into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "resource" element. The newly added element. |
|
|
|