Package com.evolveum.midpoint.xml.ns._public.common.common_3

Class FormType

java.lang.Object

com.evolveum.prism.xml.ns._public.types_3.ObjectType

com.evolveum.midpoint.prism.impl.binding.AbstractMutableObjectable

com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType

com.evolveum.midpoint.xml.ns._public.common.common_3.AssignmentHolderType

com.evolveum.midpoint.xml.ns._public.common.common_3.FormType

All Implemented Interfaces:

Containerable, Freezable, com.evolveum.midpoint.prism.impl.binding.ContainerablePrismBinding, JaxbVisitable, Objectable, DebugDumpable, Serializable

public class FormType
extends AssignmentHolderType
implements Objectable

Form definition. Forms define how a certain user interface form or dialog is presented. Forms inherently define presentation logic. The forms may contain expression or other dynamic parts. However, these parts are provided only for the purpose of improved user experience. The data that the form computes should only help the user to fill out the form or provide a value preview. The data produced by form expressions are NOT authoritative.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.impl.binding.ContainerablePrismBinding

com.evolveum.midpoint.prism.impl.binding.ContainerablePrismBinding.ContainerableList<T extends Containerable>, com.evolveum.midpoint.prism.impl.binding.ContainerablePrismBinding.ReferencableList<T extends Referencable>

Field Summary

Fields

Modifier and Type	Field	Description
static QName	COMPLEX_TYPE
static QName	CONTAINER_NAME
static ItemName	F_FORM_DEFINITION
static ItemName	F_INCLUDE_REF
static Producer<FormType>	FACTORY

Fields inherited from class com.evolveum.midpoint.xml.ns._public.common.common_3.AssignmentHolderType

F_ARCHETYPE_REF, F_ASSIGNMENT, F_DELEGATED_REF, F_ITERATION, F_ITERATION_TOKEN, F_ROLE_INFLUENCE_REF, F_ROLE_MEMBERSHIP_REF

Fields inherited from class com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType

F_DESCRIPTION, F_DIAGNOSTIC_INFORMATION, F_DOCUMENTATION, F_EXTENSION, F_FETCH_RESULT, F_INDESTRUCTIBLE, F_LENS_CONTEXT, F_LIFECYCLE_STATE, F_METADATA, F_NAME, F_OPERATION_EXECUTION, F_PARENT_ORG_REF, F_POLICY_EXCEPTION, F_POLICY_SITUATION, F_SUBTYPE, F_TENANT_REF, F_TRIGGER, F_TRIGGERED_POLICY_RULE

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
FormType()
FormType(PrismContext context)	Deprecated.

Method Summary

Modifier and Type	Method	Description
FormType	archetypeRef(ObjectReferenceType value)
FormType	archetypeRef(String oid, QName type)
FormType	archetypeRef(String oid, QName type, QName relation)
PrismObject<FormType>	asPrismObject()
FormType	assignment(AssignmentType value)
ObjectReferenceType	beginArchetypeRef()
AssignmentType	beginAssignment()
ObjectReferenceType	beginDelegatedRef()
DiagnosticInformationType	beginDiagnosticInformation()
ExtensionType	beginExtension()
OperationResultType	beginFetchResult()
FormDefinitionType	beginFormDefinition()
ObjectReferenceType	beginIncludeRef()
LensContextType	beginLensContext()
MetadataType	beginMetadata()
OperationExecutionType	beginOperationExecution()
ObjectReferenceType	beginParentOrgRef()
PolicyExceptionType	beginPolicyException()
ObjectReferenceType	beginRoleInfluenceRef()
ObjectReferenceType	beginRoleMembershipRef()
ObjectReferenceType	beginTenantRef()
TriggerType	beginTrigger()
EvaluatedPolicyRuleType	beginTriggeredPolicyRule()
FormType	clone()
FormType	delegatedRef(ObjectReferenceType value)
FormType	delegatedRef(String oid, QName type)
FormType	delegatedRef(String oid, QName type, QName relation)
FormType	description(String value)
FormType	diagnosticInformation(DiagnosticInformationType value)
FormType	documentation(String value)
<X> X	end()
boolean	equals(Object other)
FormType	extension(ExtensionType value)
FormType	fetchResult(OperationResultType value)
FormType	formDefinition(FormDefinitionType value)
FormDefinitionType	getFormDefinition()
List<ObjectReferenceType>	getIncludeRef()
FormType	includeRef(ObjectReferenceType value)
FormType	includeRef(String oid, QName type)
FormType	includeRef(String oid, QName type, QName relation)
FormType	indestructible(Boolean value)
FormType	iteration(Integer value)
FormType	iterationToken(String value)
FormType	lensContext(LensContextType value)
FormType	lifecycleState(String value)
FormType	metadata(MetadataType value)
FormType	name(PolyStringType value)
FormType	name(String value)
FormType	oid(String value)
FormType	operationExecution(OperationExecutionType value)
FormType	parentOrgRef(ObjectReferenceType value)
FormType	parentOrgRef(String oid, QName type)
FormType	parentOrgRef(String oid, QName type, QName relation)
FormType	policyException(PolicyExceptionType value)
FormType	policySituation(String value)
protected QName	prismGetContainerName()
protected QName	prismGetContainerType()
FormType	roleInfluenceRef(ObjectReferenceType value)
FormType	roleInfluenceRef(String oid, QName type)
FormType	roleInfluenceRef(String oid, QName type, QName relation)
FormType	roleMembershipRef(ObjectReferenceType value)
FormType	roleMembershipRef(String oid, QName type)
FormType	roleMembershipRef(String oid, QName type, QName relation)
void	setFormDefinition(FormDefinitionType value)
FormType	subtype(String value)
FormType	tenantRef(ObjectReferenceType value)
FormType	tenantRef(String oid, QName type)
FormType	tenantRef(String oid, QName type, QName relation)
FormType	trigger(TriggerType value)
FormType	triggeredPolicyRule(EvaluatedPolicyRuleType value)
FormType	version(String value)

Methods inherited from class com.evolveum.midpoint.xml.ns._public.common.common_3.AssignmentHolderType

createAssignmentList, getArchetypeRef, getAssignment, getDelegatedRef, getIteration, getIterationToken, getRoleInfluenceRef, getRoleMembershipRef, setIteration, setIterationToken

Methods inherited from class com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType

createOperationExecutionList, createPolicyExceptionList, createTriggerList, getDescription, getDiagnosticInformation, getDocumentation, getExtension, getFetchResult, getLensContext, getLifecycleState, getMetadata, getName, getOperationExecution, getParentOrgRef, getPolicyException, getPolicySituation, getSubtype, getTenantRef, getTrigger, getTriggeredPolicyRule, isIndestructible, setDescription, setDocumentation, setExtension, setFetchResult, setIndestructible, setLensContext, setLifecycleState, setMetadata, setName, setTenantRef

Methods inherited from class com.evolveum.midpoint.prism.impl.binding.AbstractMutableObjectable

asPrismContainer, asPrismContainerValue, getOid, getVersion, hashCode, setOid, setupContainer, setupContainerValue, setVersion, toDebugName, toDebugType, toString

Methods inherited from class com.evolveum.prism.xml.ns._public.types_3.ObjectType

accept

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.prism.Containerable

asPrismContainerValue, cloneWithoutId, debugDump, freeze, isImmutable, setupContainerValue

Methods inherited from interface com.evolveum.midpoint.prism.impl.binding.ContainerablePrismBinding

prismGetContainerableList, prismGetPropertyValue, prismGetPropertyValues, prismGetReferencable, prismGetReferencableList, prismGetReferenceObjectable, prismGetSingleContainerable, prismSetPropertyValue, prismSetReferencable, prismSetReferenceObjectable, prismSetSingleContainerable

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable

Methods inherited from interface com.evolveum.midpoint.prism.Objectable

getDescription, getName, getOid, getVersion, setDescription, setName, setOid, setupContainer, setVersion, toDebugName, toDebugType

Field Detail

COMPLEX_TYPE

public static final QName COMPLEX_TYPE

F_INCLUDE_REF

public static final ItemName F_INCLUDE_REF

F_FORM_DEFINITION

public static final ItemName F_FORM_DEFINITION

FACTORY

public static final Producer<FormType> FACTORY

CONTAINER_NAME

public static final QName CONTAINER_NAME

Constructor Detail

FormType

public FormType()

FormType

@Deprecated
public FormType(PrismContext context)

Deprecated.

Method Detail

prismGetContainerName

protected QName prismGetContainerName()

Overrides:

prismGetContainerName in class AssignmentHolderType

prismGetContainerType

protected QName prismGetContainerType()

Overrides:

prismGetContainerType in class AssignmentHolderType

asPrismObject

public PrismObject<FormType> asPrismObject()

Specified by:

asPrismObject in interface Objectable

Overrides:

asPrismObject in class AssignmentHolderType

getIncludeRef

public List<ObjectReferenceType> getIncludeRef()

getFormDefinition

public FormDefinitionType getFormDefinition()

setFormDefinition

public void setFormDefinition(FormDefinitionType value)

equals

public boolean equals(Object other)

Overrides:

equals in class AssignmentHolderType

version

public FormType version(String value)

Overrides:

version in class AssignmentHolderType

oid

public FormType oid(String value)

Overrides:

oid in class AssignmentHolderType

includeRef

public FormType includeRef(ObjectReferenceType value)

includeRef

public FormType includeRef(String oid,
                           QName type)

includeRef

public FormType includeRef(String oid,
                           QName type,
                           QName relation)

beginIncludeRef

public ObjectReferenceType beginIncludeRef()

formDefinition

public FormType formDefinition(FormDefinitionType value)

beginFormDefinition

public FormDefinitionType beginFormDefinition()

assignment

public FormType assignment(AssignmentType value)

Overrides:

assignment in class AssignmentHolderType

beginAssignment

public AssignmentType beginAssignment()

Overrides:

beginAssignment in class AssignmentHolderType

iteration

public FormType iteration(Integer value)

Overrides:

iteration in class AssignmentHolderType

iterationToken

public FormType iterationToken(String value)

Overrides:

iterationToken in class AssignmentHolderType

archetypeRef

public FormType archetypeRef(ObjectReferenceType value)

Overrides:

archetypeRef in class AssignmentHolderType

archetypeRef

public FormType archetypeRef(String oid,
                             QName type)

Overrides:

archetypeRef in class AssignmentHolderType

archetypeRef

public FormType archetypeRef(String oid,
                             QName type,
                             QName relation)

Overrides:

archetypeRef in class AssignmentHolderType

beginArchetypeRef

public ObjectReferenceType beginArchetypeRef()

Overrides:

beginArchetypeRef in class AssignmentHolderType

roleMembershipRef

public FormType roleMembershipRef(ObjectReferenceType value)

Overrides:

roleMembershipRef in class AssignmentHolderType

roleMembershipRef

public FormType roleMembershipRef(String oid,
                                  QName type)

Overrides:

roleMembershipRef in class AssignmentHolderType

roleMembershipRef

public FormType roleMembershipRef(String oid,
                                  QName type,
                                  QName relation)

Overrides:

roleMembershipRef in class AssignmentHolderType

beginRoleMembershipRef

public ObjectReferenceType beginRoleMembershipRef()

Overrides:

beginRoleMembershipRef in class AssignmentHolderType

delegatedRef

public FormType delegatedRef(ObjectReferenceType value)

Overrides:

delegatedRef in class AssignmentHolderType

delegatedRef

public FormType delegatedRef(String oid,
                             QName type)

Overrides:

delegatedRef in class AssignmentHolderType

delegatedRef

public FormType delegatedRef(String oid,
                             QName type,
                             QName relation)

Overrides:

delegatedRef in class AssignmentHolderType

beginDelegatedRef

public ObjectReferenceType beginDelegatedRef()

Overrides:

beginDelegatedRef in class AssignmentHolderType

roleInfluenceRef

public FormType roleInfluenceRef(ObjectReferenceType value)

Overrides:

roleInfluenceRef in class AssignmentHolderType

roleInfluenceRef

public FormType roleInfluenceRef(String oid,
                                 QName type)

Overrides:

roleInfluenceRef in class AssignmentHolderType

roleInfluenceRef

public FormType roleInfluenceRef(String oid,
                                 QName type,
                                 QName relation)

Overrides:

roleInfluenceRef in class AssignmentHolderType

beginRoleInfluenceRef

public ObjectReferenceType beginRoleInfluenceRef()

Overrides:

beginRoleInfluenceRef in class AssignmentHolderType

name

public FormType name(PolyStringType value)

Overrides:

name in class AssignmentHolderType

name

public FormType name(String value)

Overrides:

name in class AssignmentHolderType

description

public FormType description(String value)

Overrides:

description in class AssignmentHolderType

documentation

public FormType documentation(String value)

Overrides:

documentation in class AssignmentHolderType

subtype

public FormType subtype(String value)

Overrides:

subtype in class AssignmentHolderType

fetchResult

public FormType fetchResult(OperationResultType value)

Overrides:

fetchResult in class AssignmentHolderType

beginFetchResult

public OperationResultType beginFetchResult()

Overrides:

beginFetchResult in class AssignmentHolderType

extension

public FormType extension(ExtensionType value)

Overrides:

extension in class AssignmentHolderType

beginExtension

public ExtensionType beginExtension()

Overrides:

beginExtension in class AssignmentHolderType

parentOrgRef

public FormType parentOrgRef(ObjectReferenceType value)

Overrides:

parentOrgRef in class AssignmentHolderType

parentOrgRef

public FormType parentOrgRef(String oid,
                             QName type)

Overrides:

parentOrgRef in class AssignmentHolderType

parentOrgRef

public FormType parentOrgRef(String oid,
                             QName type,
                             QName relation)

Overrides:

parentOrgRef in class AssignmentHolderType

beginParentOrgRef

public ObjectReferenceType beginParentOrgRef()

Overrides:

beginParentOrgRef in class AssignmentHolderType

trigger

public FormType trigger(TriggerType value)

Overrides:

trigger in class AssignmentHolderType

beginTrigger

public TriggerType beginTrigger()

Overrides:

beginTrigger in class AssignmentHolderType

metadata

public FormType metadata(MetadataType value)

Overrides:

metadata in class AssignmentHolderType

beginMetadata

public MetadataType beginMetadata()

Overrides:

beginMetadata in class AssignmentHolderType

tenantRef

public FormType tenantRef(ObjectReferenceType value)

Overrides:

tenantRef in class AssignmentHolderType

tenantRef

public FormType tenantRef(String oid,
                          QName type)

Overrides:

tenantRef in class AssignmentHolderType

tenantRef

public FormType tenantRef(String oid,
                          QName type,
                          QName relation)

Overrides:

tenantRef in class AssignmentHolderType

beginTenantRef

public ObjectReferenceType beginTenantRef()

Overrides:

beginTenantRef in class AssignmentHolderType

lifecycleState

public FormType lifecycleState(String value)

Overrides:

lifecycleState in class AssignmentHolderType

operationExecution

public FormType operationExecution(OperationExecutionType value)

Overrides:

operationExecution in class AssignmentHolderType

beginOperationExecution

public OperationExecutionType beginOperationExecution()

Overrides:

beginOperationExecution in class AssignmentHolderType

lensContext

public FormType lensContext(LensContextType value)

Overrides:

lensContext in class AssignmentHolderType

beginLensContext

public LensContextType beginLensContext()

Overrides:

beginLensContext in class AssignmentHolderType

policySituation

public FormType policySituation(String value)

Overrides:

policySituation in class AssignmentHolderType

triggeredPolicyRule

public FormType triggeredPolicyRule(EvaluatedPolicyRuleType value)

Overrides:

triggeredPolicyRule in class AssignmentHolderType

beginTriggeredPolicyRule

public EvaluatedPolicyRuleType beginTriggeredPolicyRule()

Overrides:

beginTriggeredPolicyRule in class AssignmentHolderType

policyException

public FormType policyException(PolicyExceptionType value)

Overrides:

policyException in class AssignmentHolderType

beginPolicyException

public PolicyExceptionType beginPolicyException()

Overrides:

beginPolicyException in class AssignmentHolderType

diagnosticInformation

public FormType diagnosticInformation(DiagnosticInformationType value)

Overrides:

diagnosticInformation in class AssignmentHolderType

beginDiagnosticInformation

public DiagnosticInformationType beginDiagnosticInformation()

Overrides:

beginDiagnosticInformation in class AssignmentHolderType

indestructible

public FormType indestructible(Boolean value)

Overrides:

indestructible in class AssignmentHolderType

end

public <X> X end()

Overrides:

end in class AssignmentHolderType

clone

public FormType clone()

Overrides:

clone in class AssignmentHolderType