Package ch.ivyteam.ivy.application

Interface ILibrarySpecification

public interface ILibrarySpecification
Specification of a required library
Since:
10.04.2007
API:
This is a public API.

  • Method Details

    • getId

      String getId()
      Gets the identifier of the library that is required
      Returns:
      identifier of the required library
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setId

      void setId(String id)
      Sets the identifier of the library that is required
      Parameters:
      id - the identifier of the required library
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibrarySpecificationWriteId PERMISSION OR OWNS LibrarySpecificationWriteId@SYSTEM PERMISSION

    • getMinimumVersion

      ILibraryVersionSpecification getMinimumVersion()
      Get minimum version that is required. Maybe null if minimum version is not defined.
      Returns:
      minimum version or null.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • createMinimumVersion

      ILibraryVersionSpecification createMinimumVersion(QualifiedVersion minimumVersion)
      Creates a minimum version specification. Not allowed if there is already a minimum version set.
      Parameters:
      minimumVersion - the minimum version
      Returns:
      minimum version specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibraryVersionSpecificationCreate PERMISSION OR OWNS LibraryVersionSpecificationCreate@SYSTEM PERMISSION

    • deleteMinimumVersion

      void deleteMinimumVersion()
      Deletes the minimum version specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibraryVersionSpecificationDelete PERMISSION OR OWNS LibraryVersionSpecificationDelete@SYSTEM PERMISSION

    • getMaximumVersion

      ILibraryVersionSpecification getMaximumVersion()
      Get maximum version that is required. Maybe null if maximum version is not defined.
      Returns:
      maximum version or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • createMaximumVersion

      ILibraryVersionSpecification createMaximumVersion(QualifiedVersion maximumVersion)
      Creates a maximum version specification. Not allowed if there is already a maximum version set.
      Parameters:
      maximumVersion - the maximum version
      Returns:
      maximum version specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibraryVersionSpecificationCreate PERMISSION OR OWNS LibraryVersionSpecificationCreate@SYSTEM PERMISSION

    • deleteMaximumVersion

      void deleteMaximumVersion()
      Deletes the maximum version specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibraryVersionSpecificationDelete PERMISSION OR OWNS LibraryVersionSpecificationDelete@SYSTEM PERMISSION

    • isResolved

      boolean isResolved()
      Checks if the library specification is resolved. A library specification is resolved if a library is installed in the system that fits this library specification.
      Returns:
      true if library specification is resolved, otherwise false
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • isResolvedLibraryResolved

      boolean isResolvedLibraryResolved()
      Checks if the resolved library is resolved
      Returns:
      true if resolved library is resolved, otherwise false
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getResolvedLibrary

      ILibrary getResolvedLibrary()
      Gets the library that fits this library specification.
      Returns:
      library that fits this library specification. Null if no library fits the specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setResolvedLibrary

      void setResolvedLibrary(ILibrary resolvedLibrary)
      Sets the resolved library which matches the specification and will be used at runtime.
      Parameters:
      resolvedLibrary - The library which will be used at runtime.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibrarySpecificationWriteResolved PERMISSION OR OWNS LibrarySpecificationWriteResolved@SYSTEM PERMISSION

    • isResolvedLibraryFixed

      boolean isResolvedLibraryFixed()
      Determines whether the library which matches this specification is calculated at runtime or if the library was defined during deployment.
      Returns:
      true -> if a matching runtime library was defined during deployment.
      false -> if running in designer mode, or the library was deployed on a legacy server (version < 4.4)
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • findMatchingLibraries

      SortedSet<ILibrary> findMatchingLibraries()
      Returns:
      Returns libraries which match this specification. The libraries are sorted by it's version. So SortedSet.last() will return the latest library with the highest version.

      All of this matching candidates could be defined as resolved library by using setResolvedLibrary(ILibrary).

      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getPosition

      int getPosition()
      Gets the position of this library specification in relation to the other library specification of the library
      Returns:
      position of the library specification
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setPosition

      void setPosition(int position)
      Sets the position of this library specification in relation to the other library specification of the library
      Parameters:
      position - position of the library specification (Must be => 0)
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      SESSION OWNS LibrarySpecificationWriteId PERMISSION OR OWNS LibrarySpecificationWriteId@SYSTEM PERMISSION