Maps a folder in one content repository onto a folder in another, so the same content appears in both. The link is one-directional, from a source folder given by fromRepo, fromBranch and fromPath, to a target folder given by toRepo, toBranch and toPath. Both paths must be collections, ie folders rather than files. Leaving either branch null makes that end track the repository's live branch. The owning entity is the organisation the link is administered from.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| fromBranch | Branch | Branch of the source repository to read from. Null means the link tracks whatever the source repository's live branch is at the time it is resolved. |
| fromPath | String | Path of the source folder within the source branch. Must identify a folder, not a file. Never null. |
| fromRepo | Repository | Repository holding the source folder, ie the content being linked from. Never null. |
| id | long | Unique database identifier for this folder link. |
| ownerEntity | BaseEntity | Entity, normally the administering organisation, that owns this link and is used to scope it when listing links. Never null. |
| toBranch | Branch | Branch of the target repository the content is linked into. Null means the link tracks whatever the target repository's live branch is at the time it is resolved. |
| toPath | String | Path of the target folder within the target branch. Must identify a folder, not a file. Never null. |
| toRepo | Repository | Repository holding the target folder, ie where the linked content appears. Never null. |
Methods
getId()
Returns: long
Unique database identifier for this folder link.
getOwnerEntity()
Returns: BaseEntity
Entity, normally the administering organisation, that owns this link and is used to scope it when listing links. Never null.
getFromRepo()
Returns: Repository
Repository holding the source folder, ie the content being linked from. Never null.
getFromBranch()
Returns: Branch
Branch of the source repository to read from. Null means the link tracks whatever the source repository's live branch is at the time it is resolved.
getFromPath()
Returns: String
Path of the source folder within the source branch. Must identify a folder, not a file. Never null.
getToRepo()
Returns: Repository
Repository holding the target folder, ie where the linked content appears. Never null.
getToBranch()
Returns: Branch
Branch of the target repository the content is linked into. Null means the link tracks whatever the target repository's live branch is at the time it is resolved.
getToPath()
Returns: String
Path of the target folder within the target branch. Must identify a folder, not a file. Never null.