Interface DocumentSelector<T>
- All Superinterfaces:
ModelObjectSelector<T,
DocumentSelector<T>, DocumentReference>
public interface DocumentSelector<T>
extends ModelObjectSelector<T,DocumentSelector<T>,DocumentReference>
Interface for selecting the document using optional revision and mandatory project id document path or space id and document name.
The selection is finished by using
path(String)
, projectSpaceAndName(String, String, String)
or spaceReferenceAndName(SpaceReference, String)
method
and the selector object cannot be used anymore after that.- Since:
- 3.9.0
-
Method Summary
Modifier and TypeMethodDescriptionFinishes selecting the document using the relative path to document.projectSpaceAndName
(String projectId, String spaceId, String documentName) Finishes selecting the document using the space id and document name as separate parameters.spaceReferenceAndName
(SpaceReference space, String documentName) Finishes selecting the document using the space reference and document name,Methods inherited from interface com.polarion.alm.shared.api.model.ModelObjectSelector
oldApiObject, reference, revision
-
Method Details
-
path
Finishes selecting the document using the relative path to document.- Specified by:
path
in interfaceModelObjectSelector<T,
DocumentSelector<T>, DocumentReference> - Parameters:
documentPath
- - the value as returned byDocumentReference.toPath()
- Throws:
IllegalStateException
- after the selection was finished
-
projectSpaceAndName
@NotNull T projectSpaceAndName(@NotNull String projectId, @Nullable String spaceId, @NotNull String documentName) Finishes selecting the document using the space id and document name as separate parameters.- Parameters:
spaceId
- - The space id as returned bySpaceReference.spaceId()
- Throws:
IllegalStateException
- after the selection was finished
-