Packages

t

com.nawforce.common.org

PackageAPI

trait PackageAPI extends Package

Self Type
PackageImpl
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PackageAPI
  2. Package
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def flush(pc: ParsedCache): Unit

    Flush all types to the passed cache

  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getDependencies(typeId: TypeIdentifier, inheritanceOnly: Boolean): Array[TypeIdentifier]

    Returns set of Types that are depended on by the passed Type

    Returns set of Types that are depended on by the passed Type

    If inheritanceOnly is true only superClass & inheritance dependencies are reported for Apex defined Types, otherwise all dependencies are included.

    Definition Classes
    PackageAPIPackage
  12. def getDependencyHolders(typeId: TypeIdentifier): Array[TypeIdentifier]

    Returns set of Types that depend on the passed Type.

    Returns set of Types that depend on the passed Type.

    The returned array may be stale in that it can contain Types which used to hold a dependency but not longer do.

    Definition Classes
    PackageAPIPackage
  13. def getNamespaces(withDependents: Boolean): Array[String]

    The namespace of the package or the package and its dependent packages.

    The namespace of the package or the package and its dependent packages.

    An empty namespace indicates the "unmanaged" package.

    Definition Classes
    PackageAPIPackage
  14. def getPathsOfType(typeId: TypeIdentifier): Array[String]

    Get the path(s) of the metadata file that defined a Type.

    Get the path(s) of the metadata file that defined a Type.

    Returns an empty array if the Type is not defined within the current package.

    Definition Classes
    PackageAPIPackage
  15. def getSummaryOfType(typeId: TypeIdentifier): TypeSummary

    Get the summary information for a Type.

    Get the summary information for a Type.

    Returns a null if the Type is not defined within the current package.

    Definition Classes
    PackageAPIPackage
  16. def getSummaryOfTypeAsJSON(typeId: TypeIdentifier): String

    JSON encoding of summary information for a type.

    JSON encoding of summary information for a type.

    Returns a null if the Type is not defined within the current package.

    Definition Classes
    PackageAPIPackage
  17. def getTypeOfPath(path: String): TypeIdentifier

    Get a Type from the path of a metadata file.

    Get a Type from the path of a metadata file.

    Returns a null if the path does not identify metadata that creates a Type within the current package.

    Definition Classes
    PackageAPIPackage
  18. def getViewOfType(path: String, contents: SourceBlob): ViewInfo

    Obtain view information for a Type.

    Obtain view information for a Type.

    The view information contains a detailed description of the Type that can either be inspected. In some cases it may not be possible to construct a Type at all, in which case the view information may only contain diagnostic information.

    You can either pass in a path and contents or a path and null contents. If contents are not provided they will be read from the path if possible. Where contents are provided the path is only used for error identification purposes.

    If the path does not identify supported metadata or that path is not valid for this package no Type will be returned and the view diagnostics will indicate the error.

    Definition Classes
    PackageAPIPackage
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def refresh(path: String, contents: SourceBlob): Unit

    Refresh a type in the package.

    Refresh a type in the package.

    This registers that the metadata in a file may need updating. The refresh is queued until the Org metdata is next flushed so that changes are made in batches for efficiency.

    Refreshing causes dependent metadata to be re-validated so issues may be reported against other metadata types after the flush has completed.

    You can either pass in a path and contents or a path and null contents. If contents are not provided they will be read from the path if possible. Where contents are provided the path is only used for error identification purposes. If no contents are provided and there is no file to read the content from the contribution of this metadata to a type will be removed.

    Definition Classes
    PackageAPIPackage
  25. def refreshBatched(refreshRequests: Seq[RefreshRequest]): Boolean
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Package

Inherited from AnyRef

Inherited from Any

Ungrouped