Package com.polarion.alm.shared.api.model.document

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 Type	Method	Description
T	path(String documentPath)	Finishes selecting the document using the relative path to document.
T	projectSpaceAndName(String projectId, String spaceId, String documentName)	Finishes selecting the document using the space id and document name as separate parameters.
T	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

@NotNull
T path(@NotNull
 String documentPath)

Finishes selecting the document using the relative path to document.

Specified by:

path in interface ModelObjectSelector<T,DocumentSelector<T>,DocumentReference>

Parameters:

documentPath - - the value as returned by DocumentReference.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 by SpaceReference.spaceId()

Throws:

IllegalStateException - after the selection was finished

spaceReferenceAndName

@NotNull
T spaceReferenceAndName(@NotNull
 SpaceReference space,
 @NotNull
 String documentName)

Finishes selecting the document using the space reference and document name,

Throws:

IllegalStateException - after the selection was finished