Package org.apache.ofbiz.webtools.artifactinfo

Class FormWidgetArtifactInfo

java.lang.Object

org.apache.ofbiz.webtools.artifactinfo.ArtifactInfoBase

org.apache.ofbiz.webtools.artifactinfo.FormWidgetArtifactInfo

All Implemented Interfaces:

Comparable<ArtifactInfoBase>

public class FormWidgetArtifactInfo
extends ArtifactInfoBase

Constructor Summary

Constructors

Constructor	Description
FormWidgetArtifactInfo(String formName, String formLocation, ArtifactInfoFactory aif)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDisplayName()
String	getDisplayType()
Set<EntityArtifactInfo>	getEntitiesUsedInForm()	Gets entities used in form.
Set<FormWidgetArtifactInfo>	getFormsExtendingThisForm()	Gets forms extending this form.
FormWidgetArtifactInfo	getFormThisFormExtends()	Gets form this form extends.
URL	getLocationURL()
Set<ControllerRequestArtifactInfo>	getRequestsLinkedToInForm()	Gets requests linked to in form.
Set<ControllerRequestArtifactInfo>	getRequestsTargetedByForm()	Gets requests targeted by form.
Set<ScreenWidgetArtifactInfo>	getScreensIncludingThisForm()	Gets screens including this form.
Set<ServiceArtifactInfo>	getServicesUsedInForm()	Gets services used in form.
String	getType()
String	getUniqueId()
int	hashCode()
void	populateAll()	note this is mean to be called after the object is created and added to the ArtifactInfoFactory.allFormInfos in ArtifactInfoFactory.getFormWidgetArtifactInfo
protected void	populateEntitiesFromNameSet(Set<String> allEntityNameSet)	Populate entities from name set.
protected void	populateFormExtended()	Populate form extended.
protected void	populateLinkedRequests(Set<String> allRequestUniqueId)	Populate linked requests.
protected void	populateServicesFromNameSet(Set<String> allServiceNameSet)	Populate services from name set.
protected void	populateTargetedRequests(Set<String> allRequestUniqueId)	Populate targeted requests.

Methods inherited from class org.apache.ofbiz.webtools.artifactinfo.ArtifactInfoBase

compareTo, getAif, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FormWidgetArtifactInfo

public FormWidgetArtifactInfo(String formName,
 String formLocation,
 ArtifactInfoFactory aif)
                       throws GeneralException

Throws:

GeneralException

Method Details

populateAll

public void populateAll()
                 throws GeneralException

note this is mean to be called after the object is created and added to the ArtifactInfoFactory.allFormInfos in ArtifactInfoFactory.getFormWidgetArtifactInfo

Throws:

GeneralException

populateFormExtended

protected void populateFormExtended()
                             throws GeneralException

Populate form extended.

Throws:

GeneralException - the general exception

populateEntitiesFromNameSet

protected void populateEntitiesFromNameSet(Set<String> allEntityNameSet)
                                    throws GeneralException

Populate entities from name set.

Parameters:

allEntityNameSet - the all entity name set

Throws:

GeneralException - the general exception

populateServicesFromNameSet

protected void populateServicesFromNameSet(Set<String> allServiceNameSet)
                                    throws GeneralException

Populate services from name set.

Parameters:

allServiceNameSet - the all service name set

Throws:

GeneralException - the general exception

populateLinkedRequests

protected void populateLinkedRequests(Set<String> allRequestUniqueId)
                               throws GeneralException

Populate linked requests.

Parameters:

allRequestUniqueId - the all request unique id

Throws:

GeneralException - the general exception

populateTargetedRequests

protected void populateTargetedRequests(Set<String> allRequestUniqueId)
                                 throws GeneralException

Populate targeted requests.

Parameters:

allRequestUniqueId - the all request unique id

Throws:

GeneralException - the general exception

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class ArtifactInfoBase

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in class ArtifactInfoBase

getType

public String getType()

Specified by:

getType in class ArtifactInfoBase

getUniqueId

public String getUniqueId()

Specified by:

getUniqueId in class ArtifactInfoBase

getLocationURL

public URL getLocationURL()
                   throws MalformedURLException

Specified by:

getLocationURL in class ArtifactInfoBase

Throws:

MalformedURLException

equals

public boolean equals(Object obj)

Overrides:

equals in class ArtifactInfoBase

hashCode

public int hashCode()

Overrides:

hashCode in class ArtifactInfoBase

getEntitiesUsedInForm

public Set<EntityArtifactInfo> getEntitiesUsedInForm()

Gets entities used in form.

Returns:

the entities used in form

getServicesUsedInForm

public Set<ServiceArtifactInfo> getServicesUsedInForm()

Gets services used in form.

Returns:

the services used in form

getFormThisFormExtends

public FormWidgetArtifactInfo getFormThisFormExtends()

Gets form this form extends.

Returns:

the form this form extends

getFormsExtendingThisForm

public Set<FormWidgetArtifactInfo> getFormsExtendingThisForm()

Gets forms extending this form.

Returns:

the forms extending this form

getScreensIncludingThisForm

public Set<ScreenWidgetArtifactInfo> getScreensIncludingThisForm()

Gets screens including this form.

Returns:

the screens including this form

getRequestsLinkedToInForm

public Set<ControllerRequestArtifactInfo> getRequestsLinkedToInForm()

Gets requests linked to in form.

Returns:

the requests linked to in form

getRequestsTargetedByForm

public Set<ControllerRequestArtifactInfo> getRequestsTargetedByForm()

Gets requests targeted by form.

Returns:

the requests targeted by form