Matterial API Object - Document
com.matterial.mtr.api.object.Document
Constants
Status
/**
* author marked this version as "ready".
* every "ready" version could not be overwritten, mtr will generate a new version automatically.
* ready means, this version was saved with one of these "review"-options set:
* 1) no review, 2) reviewed by myself, 3) review requested
* this version will be saved without "ready"-bit set as long as no review-option was chosen.
*/
public static final int STATUS_BIT_READY = 1;
/**
* "currently in processing" marks the version, which should be opened in editor and showed to users with edit-right.
*/
public static final int STATUS_BIT_CURRENTLY_IN_PROCESSING = 2;
/**
* this bit marks the version as reviewed;
*/
public static final int STATUS_BIT_REVIEWED = 4;
Editor type
public static final int EDITOR_TYPE_MARKDOWN = 0;
public static final int EDITOR_TYPE_WYSIWYG = 1;
Index field
// *** document-poperties;
public static final String INDEX_FIELD_ID = "id";
public static final String INDEX_EDITOR_TYPE = "editorType";
public static final String INDEX_FIELD_CREATE_TIME_IN_SECONDS = "createTimeInSeconds";
public static final String INDEX_FIELD_CLICK_COUNT = "clickCount";
public static final String INDEX_FIELD_VALID = "valid";
public static final String INDEX_FIELD_VALID_BEGIN_IN_SECONDS = "validBeginInSeconds";
public static final String INDEX_FIELD_VALID_END_IN_SECONDS = "validEndInSeconds";
public static final String INDEX_FIELD_REMOVED = "removed";
public static final String INDEX_FIELD_ARCHIVED = "archived";
public static final String INDEX_FIELD_ARCHIVED_BEGIN_IN_SECONDS = "archivedBeginInSeconds";
public static final String INDEX_FIELD_REVIEW_UNTIL_IN_SECONDS = "reviewUntilInSeconds";
public static final String INDEX_FIELD_REMOVE_TIME_IN_SECONDS = "removeTimeInSeconds";
public static final String INDEX_FIELD_DOWNLOAD_COUNT = "downloadCount";
public static final String INDEX_FIELD_TEMPLATE = "template";
public static final String INDEX_FIELD_BIO = "bio";
public static final String INDEX_FIELD_LANDSCAPE = "landscape";
public static final String INDEX_FIELD_READ_CONFIRMATION_ACTIVE = "readConfirmationActive";
// *** document-language-version-properties;
public static final String INDEX_FIELD_LANGUAGE_VERSION_ID = "languageVersionId";
public static final String INDEX_FIELD_LANGUAGE_VERSION_VERSION = "languageVersionVersion";
public static final String INDEX_FIELD_LANGUAGE_VERSION_TITLE = "languageVersionTitle";
public static final String INDEX_FIELD_LANGUAGE_VERSION_ABSTRACT = "languageVersionAbstract";
public static final String INDEX_FIELD_LANGUAGE_VERSION_VERSION_COMMENT = "languageVersionVersionComment";
public static final String INDEX_FIELD_LANGUAGE_VERSION_VERSION_COMMENT_HTML = "languageVersionVersionCommentHtml";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CUSTOM_VERSION_STRING = "languageVersionCustomVersionString";
public static final String INDEX_FIELD_LANGUAGE_VERSION_STATUS = "languageVersionStatus";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CURRENTLY_IN_PROCESSING = "languageVersionCurrentlyInProcessing";
public static final String INDEX_FIELD_LANGUAGE_VERSION_READY = "languageVersionReady";
public static final String INDEX_FIELD_LANGUAGE_VERSION_REVIEWED = "languageVersionReviewed";
public static final String INDEX_FIELD_LANGUAGE_VERSION_REVIEW_REQUESTED = "languageVersionReviewRequested";
public static final String INDEX_FIELD_LANGUAGE_VERSION_NOTIFY_ON_REVIEW = "languageVersionNotifyOnReview";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CAS_ID = "languageVersionCasId";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CAS_ID_PDF = "languageVersionCasIdPdf";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CAS_ID_THUMBNAIL = "languageVersionCasIdThumbnail";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CAS_MD5 = "languageVersionCasMd5";
public static final String INDEX_FIELD_LANGUAGE_VERSION_FILE_SIZE = "languageVersionFileSize";
public static final String INDEX_FIELD_LANGUAGE_VERSION_FILE_SIZE_PDF = "languageVersionFileSizePdf";
public static final String INDEX_FIELD_LANGUAGE_VERSION_FILE_SIZE_THUMBNAIL = "languageVersionFileSizeThumbnail";
public static final String INDEX_FIELD_LANGUAGE_VERSION_CREATE_TIME_IN_SECONDS = "languageVersionCreateTimeInSeconds";
public static final String INDEX_FIELD_LANGUAGE_VERSION_LAST_CHANGE_IN_SECONDS = "languageVersionLastChangeInSeconds";
public static final String INDEX_FIELD_LANGUAGE_VERSION_VALID_BEGIN_IN_SECONDS = "languageVersionValidBeginInSeconds";
public static final String INDEX_FIELD_LANGUAGE_VERSION_VALID_END_IN_SECONDS = "languageVersionValidEndInSeconds";
public static final String INDEX_FIELD_LANGUAGE_VERSION_MIME_TYPE = "languageVersionMimeType";
public static final String INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_ID = "languageVersionLanguageId";
public static final String INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY = "languageVersionLanguageKey";
// *** special fields;
public static final String INDEX_FIELD_SUCCESSOR_ID = "successorId";
public static final String INDEX_FIELD_FIRST_READ_TIMES_IN_SECONDS = "firstReadTimesInSeconds";
public static final String INDEX_FIELD_LAST_READ_TIMES_IN_SECONDS = "lastReadTimesInSeconds";
public static final String INDEX_FIELD_READ_CONFIRMATION_TIMES_IN_SECONDS = "readConfirmationTimesInSeconds";
public static final String INDEX_FIELD_LAST_WRITE_TIMES_IN_SECONDS = "lastWriteTimesInSeconds";
public static final String INDEX_FIELD_LAST_WRITE_TIME_IN_SECONDS = "lastWriteTimeInSeconds";
public static final String INDEX_FIELD_ROLE_RELATION_TYPE = "roleRelationType";
public static final String INDEX_FIELD_ROLE_RELATION_READ_CONFIRMATION_REQUESTED = "roleRelationReadConfirmationRequested";
public static final String INDEX_FIELD_SUM_RATING = "sumRating";
public static final String INDEX_FIELD_REVIEW_RIGHT = "reviewRight";
public static final String INDEX_FIELD_MENTIONED_IN_COMMENT_UNREAD = "mentionedInCommentUnread";
public static final String INDEX_FIELD_SNAP = "snap";
// *** lists;
public static final String INDEX_FIELD_RELATED_DOCUMENT_IDS = "relatedDocumentIds";
// *** related objects;
public static final String INDEX_FIELD_CATEGORIES = "categories";
public static final String INDEX_FIELD_ROLE_RIGHTS = "roleRights";
public static final String INDEX_FIELD_RESPONSIBLES = "responsibles";
public static final String INDEX_FIELD_FOLLOWERS = "followers";
public static final String INDEX_FIELD_MARKED_AS_HELPFUL_BY = "markedAsHelpfulBy";
public static final String INDEX_FIELD_ATTACHMENTS = "attachments";
public static final String INDEX_FIELD_LANGUAGE_ATTACHMENTS = "languageAttachments";
public static final String INDEX_FIELD_DOCUMENT_ATTACHMENTS = "documentAttachments";
public static final String INDEX_FIELD_ADDITIONAL_PROPERTIES = "additionalProperties";
public static final String INDEX_FIELD_EXTENSION_VALUES = "extensionValues";
public static final String INDEX_FIELD_COMMENTS = "comments";
// *** should not be indexed;
public static final String INDEX_FIELD_PARTIAL_UPDATE_FOLLOWERS = "partialUpdateFollowers";
public static final String INDEX_FIELD_PARTIAL_UPDATE_MARKED_HELPFUL_BY = "partialUpdateMarkedHelpfulBy";
public static final String INDEX_FIELD_PARTIAL_UPDATE_READ_TIME = "partialUpdateReadTime";
public static final String INDEX_FIELD_PARTIAL_UPDATE_CATEGORIES = "partialUpdateCategories";
public static final String INDEX_FIELD_PARTIAL_UPDATE_SNAP_FLAG = "partialUpdateSnapFlag";
public static final String INDEX_FIELD_PARTIAL_UPDATE_COMMENTS = "partialUpdateComments";
public static final String INDEX_FIELD_PARTIAL_UPDATE_ADDITIONAL_PROPERTIES = "partialUpdateAdditionalProperties";
public static final String INDEX_FIELD_PARTIAL_UPDATE_ARCHIVED = "partialUpdateArchived";
public static final String INDEX_FIELD_PARTIAL_UPDATE_REMOVED = "partialUpdateRemoved";
public static final String INDEX_FIELD_PARTIAL_UPDATE_RESPONSIBLES = "partialUpdateResponsibles";
public static final String INDEX_FIELD_PARTIAL_UPDATE_ROLE_RIGHTS = "partialUpdateRoleRights";
Order by
public static final String ORDER_BY_ID = "id";
public static final String ORDER_BY_VALID = "valid";
public static final String ORDER_BY_ARCHIVED = "archived";
public static final String ORDER_BY_ARCHIVED_BEGIN_IN_SECONDS = "archivedBeginInSeconds";
public static final String ORDER_BY_REMOVED = "removed";
public static final String ORDER_BY_CLICK_COUNT = "clickCount";
public static final String ORDER_BY_VALID_END_IN_SECONDS = "validEndInSeconds";
public static final String ORDER_BY_CREATE_TIME_IN_SECONDS = "createTimeInSeconds";
public static final String ORDER_BY_VALID_BEGIN_OR_CREATE_TIME = "validBeginOrCreateTime";
public static final String ORDER_BY_FIRST_READ_TIME_AND_VALID_BEGIN = "firstReadTimeAndValidBegin";
public static final String ORDER_BY_LANGUAGE_VERSION_TITLE = "languageVersionTitle";
public static final String ORDER_BY_LANGUAGE_VERSION_LANGUAGE_PRIO = "languageVersionLanguagePrio";
public static final String ORDER_BY_LANGUAGE_VERSION_VERSION = "languageVersionVersion";
public static final String ORDER_BY_LAST_READ_TIME = "lastReadTime";
public static final String ORDER_BY_LANGUAGE_VERSION_LAST_CHANGE_IN_SECONDS = "languageVersionLastChangeInSeconds";
public static final String ORDER_BY_LANGUAGE_VERSION_CREATE_TIME_IN_SECONDS = "languageVersionCreateTimeInSeconds";
public static final String ORDER_BY_LANGUAGE_VERSION_STATUS = "languageVersionStatus";
public static final String ORDER_BY_SUM_RATING = "sumRating";
public static final String ORDER_BY_FIRST_READ_TIME_AND_LAST_CHANGE = "firstReadTimeAndLastChange";
public static final String ORDER_BY_MENTIONED_IN_COMMENT = "mentionedInComment";
Partial update
// list of keys for specific partial index updates
private static final List<String> PARTIAL_UPDATE_KEYSET_FOLLOWERS = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_FOLLOWERS);
private static final List<String> PARTIAL_UPDATE_KEYSET_MARKED_HELPFUL_BY = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_SUM_RATING,
INDEX_FIELD_MARKED_AS_HELPFUL_BY);
private static final List<String> PARTIAL_UPDATE_KEYSET_READ_TIME = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_FIRST_READ_TIMES_IN_SECONDS,
INDEX_FIELD_LAST_READ_TIMES_IN_SECONDS,
INDEX_FIELD_READ_CONFIRMATION_TIMES_IN_SECONDS);
private static final List<String> PARTIAL_UPDATE_KEYSET_CATEGORIES = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_CATEGORIES);
private static final List<String> PARTIAL_UPDATE_KEYSET_SNAP_FLAG = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_SNAP);
private static final List<String> PARTIAL_UPDATE_KEYSET_COMMENTS = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_COMMENTS);
private static final List<String> PARTIAL_UPDATE_KEYSET_ADDITIONAL_PROPERTIES = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_ADDITIONAL_PROPERTIES);
private static final List<String> PARTIAL_UPDATE_KEYSET_ARCHIVED = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_ARCHIVED,
INDEX_FIELD_ARCHIVED_BEGIN_IN_SECONDS);
private static final List<String> PARTIAL_UPDATE_KEYSET_REMOVED = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_REMOVED,
INDEX_FIELD_REMOVE_TIME_IN_SECONDS);
private static final List<String> PARTIAL_UPDATE_KEYSET_RESPONSIBLES = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_RESPONSIBLES);
private static final List<String> PARTIAL_UPDATE_KEYSET_ROLE_RIGHTS = Arrays.asList(INDEX_FIELD_ID,
INDEX_FIELD_LANGUAGE_VERSION_ID,
INDEX_FIELD_LANGUAGE_VERSION_LANGUAGE_KEY,
INDEX_FIELD_ROLE_RIGHTS);
