Java Doc for Document.java in  » Content-Management-System » daisy » org » outerj » daisy » repository » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Since one object is used to manipulate both the document and document variant, most methods include a mentioning of whether they apply to the document or the document variant. All methods inherited from VersionedData are variant-level methods.

A document can be created using Repository.createDocument(StringString) or retrieved using Repository.getDocument(Stringboolean) .

Returns -1 if there is no such version.

This is an automatically calculated field.

This is a document-level property.

Returns -1 if there is no such version.

This is an automatically calculated field.

This is a variant-level method.
Parameters:
  fresh - if true, the lock information will be refetched.

This is a variant-level property.

If only changes have been done to document-level properties, only the document will be saved.

This can only be done for document IDs in a namespace other than the namespace of the current repository.

This is a variant-level method.

Will throw an exception if the document type does not exist.

Changing the documenttype does not influence the content of the document, you have to assure yourself that you update/add/remove parts and fields so that the document conforms to the document type.

The document type is a variant-level property.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.
Parameters:
  name - name of the field type

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.

This is a document-level property.

This is a variant-level method.

This is a variant-level method.

The document type is a variant-level property.

Returns -1 if there is no such version.

This is an automatically calculated field. This information is fetched when this document object is retrieved and is not updated afterwards.

This is a variant level method.

This is a document-level property. See also Document.getVariantLastModified() .

This is a document-level property. See also Document.getVariantLastModifier() .

This is a variant-level method.

This is a variant-level property.

Returns -1 if there is no such version.

This is an automatically calculated field. This information is fetched when this document object is retrieved and is not updated afterwards.

This is a variant level method.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.
Parameters:
  fresh - if true, the lock information will be refetched. Otherwisethe existing information stored in this Document object willbe returned (which may be out of date).

The document name is a variant-level property.

This is exactly the same as calling VersionedData.getDocumentName .

The owner is a document-level property.

Setting the reference language is also used as an indication that the document should be considered to be under "translation management".

this is a document level method

This is a variant-level property. See also Document.getLastModified() .

This is a variant-level property. See also Document.getLastModifier() .

Note that in contrast with the Document.getVersions() method, typical implementations will usually return a Version object containing all details about the version.

This is a variant-level method.

In a typical implementation, the returned Version objects will only contain basic information about the version (like its id and creation time) which is needed to show a version list, but the actual version content (fields, parts, ...) will only be loaded when requested.

This is a variant-level method.

This is a variant-level method.

This is a document-level property.

This is a variant-level property.

Changing a lock doesn't need a Document.save() call afterwards, calling this method has immediate effect.

The lock can be removed with Document.releaseLock() .

This is a variant-level method.
Parameters:
  duration - indication of how long the lock should remain (in ms).Use -1 for a never-expiring lock. false if someone else already has a lock on this document, inwhich case you can call Document.getLockInfo(boolean) with falseas parameter to know who is holding the lock.

This is a variant-level method. true if the lock is removed (or if there was no lock). If a lockremains on the document, false will be returned, in which caseyou can call Document.getLockInfo(boolean) with falseas parameter to know who is holding the lock.

This is the same as calling Document.save(boolean) with argument true.

If only changes have been done to document-level properties, only the document will be saved. If only changes have been done to variant-level properties, only the variant will be saved.

If this is a new document, it will cause an id to be assigned to this document object.

Saving the document variant might or might not cause the creation of a new version, depending on whether any versioned data has changed. Versioned data includes the parts, fields, links and the document's name. So if for example only the retired flag changed, customfields were changed, or collection membership changed, no new version will be created. After saving, you can get the new version id from the method Document.getLastVersionId() . The state of the new version can be influenced by using Document.setNewVersionState(org.outerj.daisy.repository.VersionState) before calling save().

If someone else holds a pessimistic lock on the document variant, saving it will fail. Likewise, if another person saved the document since you retrieved this document object (ie a concurrent modification), saving will also fail. Note that locks apply only to document variants, so don't protect from concurrent changes to document-level properties.

Saving a document will cause the server to send out an assynchronous event, to which other processes can listen, for example the full text indexer. (There are separate events for updates to the document and the variant)

Using the argument validate you can specify whether the document variant should be validated against its document type. Usually you will always provide true here. As an example use case for not using validation, it might be that you just want to mark a document as retired without bothering that its content doesn't correspond to the schema anymore.
throws:
  DocumentTypeInconsistencyException - in case validation against the schema fails.

This is a variant-level method.

This is a variant-level method.

See Document.setDocumentTypeChecksEnabled to disable checks against the document type.
Parameters:
  name - name of the field type of the field to set.
Parameters:
  value - the value of the field, the type of the object must be in correspondence with the ValueType of the field type.For multi-value fields, the value should be an array (i.e. Object[] or a more specifically typed array).For link field types, the value is a VariantKey object. The branch and language fields of the VariantKeyobject can be -1 to indicate they are the same as the containing document (recommended for most uses).For hierarchical fields, the value is a HierarchyPath containing values according to the field type.For multi-value hierarchical fields, the value is an array of HierarchyPath objects.

This is a variant-level method.

The document name is a variant-level property.

By default this is null

By default this is ChangeType.MAJOR

The 'synced with' indicates the version is synced with another language:version.

Use setSyncedWithVersion(-1,-1) to clear any previous set value.

Use setSyncedWith(null, -1) to indicate the document is not synced anymore.

See also Document.setNewSyncedWith(long,long) .

By default this is VersionState.PUBLISH.

The owner is a document-level property.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.

This is a variant-level method.
Parameters:
  fileName - allowed to be null (to remove the filename information)

This is a variant-level method.
Parameters:
  fileName - allowed to be null (to remove the filename information)

This is a variant-level method.

This is a variant-level method.

This is a document-level property.

This can only be done for document IDs in a namespace other than the namespace of the current repository. This is simply because the current repository is responsible itself for the assigning numbers to its documents. For foreign namespaces, it is assumed that some external entity is responsible for the numbering (typically another Daisy repository, though it could be anything).

Setting the document ID is only possible for new, not-yet-saved documents.

If a document with the given ID would already exist in the repository, then this will give an exception when saving the document.
Parameters:
  documentId - allowed to be null, in which case a previous setting is reset
since:
   Daisy 2.0

This is a variant-level property.