\DMSDocumentInterface
Interface for a DMSDocument used in the Document Management System. A DMSDocument is create by storing a File object in an instance of the DMSInterface. All write operations on the DMSDocument create a new relation, so we never need to explicitly call the write() method on the DMSDocument DataObject
Synopsis
interface DMSDocumentInterface
{
- // methods
- public String getLink()
- public void getExtension()
- public string getSize()
- public int getAbsoluteSize()
- public DMSDocumentInstance replaceDocument()
- public null embargoIndefinitely()
- public bool isHidden()
- public bool isEmbargoed()
- public null embargoUntilDate()
- public null embargoUntilPublished()
- public null clearEmbargo()
- public bool isExpired()
- public null expireAtDate()
- public null clearExpiry()
- public DataList getVersions()
Methods
public
- clearEmbargo() — Clears any previously set embargos, so the DMSDocument always shows up in all queries.
- clearExpiry() — Clears any previously set expiry.
- embargoIndefinitely() — Hides the DMSDocument, so it does not show up when getByPage($myPage) is called (without specifying the $showEmbargoed = true parameter). This is similar to expire, except that this method should be used to hide DMSDocuments that have not yet gone live.
- embargoUntilDate() — Hides the DMSDocument, so it does not show up when getByPage($myPage) is called. Automatically un-hides the DMSDocument at a specific date.
- embargoUntilPublished() — Hides the document until any page it is linked to is published
- expireAtDate() — Hides the DMSDocument at a specific date, so it does not show up when getByPage($myPage) is called.
- getAbsoluteSize() — Return the size of the file associated with the document, in bytes.
- getExtension() — Return the extension of the file associated with the document
- getLink() — Returns a link to download this DMSDocument from the DMS store
- getSize() — Returns the size of the file type in an appropriate format.
- getVersions() — Returns a DataList of all previous Versions of this DMSDocument (check the LastEdited date of each object to find the correct one)
- isEmbargoed() — Returns if this is DMSDocument is embargoed.
- isExpired() — Returns if this is DMSDocument is expired.
- isHidden() — Returns if this is DMSDocument is embargoed or expired.
- replaceDocument() — Takes a File object or a String (path to a file) and copies it into the DMS, replacing the original document file but keeping the rest of the document unchanged.