Interface PrismReferenceValue

    • Method Detail

      • getOid

        String getOid()
        OID of the object that this reference refers to (reference target). May return null, but the reference is in that case incomplete and unusable.
        the target oid
      • setOid

        void setOid​(String oid)
      • getObject

        PrismObject getObject()
        Returns object that this reference points to. The object is supposed to be used for caching and optimizations. Only oid and type of the object really matters for the reference. The object is transient. It will NOT be serialized. Therefore the client must expect that the object can disappear when serialization boundary is crossed. The client must expect that the object is null.
      • getTargetType

        QName getTargetType()
        Returns XSD type of the object that this reference refers to. It may be used in XPath expressions and similar filters. May return null if the type name is not set.
        the target type name
      • setTargetType

        void setTargetType​(QName targetType)
      • setTargetType

        void setTargetType​(QName targetType,
                           boolean allowEmptyNamespace)
        targetType -
        allowEmptyNamespace - This is an ugly hack. See comment in DOMUtil.validateNonEmptyQName.
      • getTargetName

        PolyString getTargetName()
        Returns cached name of the target object. This is a ephemeral value. It is usually not stored. It may be computed at object retrieval time or it may not be present at all. This is NOT an authoritative information. Setting it or changing it will not influence the reference meaning. OID is the only authoritative linking mechanism.
        cached name of the target object.
      • setTargetName

        void setTargetName​(PolyString name)
      • getTargetTypeCompileTimeClass

        Class<Objectable> getTargetTypeCompileTimeClass()
      • getRelation

        QName getRelation()
      • setRelation

        void setRelation​(QName relation)
      • getDescription

        String getDescription()
      • setDescription

        void setDescription​(String description)
      • toCanonical

        PrismReferenceValue toCanonical()
        Returns a version of this value that is canonical, that means it has the minimal form. E.g. it will have only OID and no object.
      • debugDump

        String debugDump()
        Description copied from interface: DebugDumpable
        Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.
        Specified by:
        debugDump in interface DebugDumpable
        content of the object intended for diagnostics by system administrator.
      • debugDump

        String debugDump​(int indent,
                         boolean expandObject)
      • shortDump

        void shortDump​(StringBuilder sb)
        Description copied from interface: ShortDumpable
        Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.
        Specified by:
        shortDump in interface ShortDumpable
        sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.