com.sap.tc.webdynpro.progmodel.repository
Interface IWDViewUsageInfo

All Superinterfaces:

com.sap.tc.cmi.model.ICMIGenericModelClass, com.sap.tc.cmi.model.ICMIModelClass, IWDRepositoryModelClass

public interface IWDViewUsageInfo

extends IWDRepositoryModelClass

Interface of progmodel repository model class "IWDViewUsageInfo". Copyright (c) 2002 - 2003. SAP AG

Method Summary

int	countOfNavigationLinks() Determine number of elements in 1:n association NavigationLinks.
int	countOfViewContainerAssignments() Determine number of elements in 1:n aggregation ViewContainerAssignments.
IWDNavigationTargetReferenceInfo	createNavigationTarget(java.lang.String sourcePlugName, IWDViewUsageInfo targetViewUsage, java.lang.String targetPlugName) Creates a new navigation target
IWDViewContainerAssignmentInfo	createViewContainerAssignment() Creates a new view container assignment in this view usage.
void	deleteAllNavigationTargets(java.lang.String sourcePlugName) Deletes all navigation targets of an outbound plug.
void	deleteNavigationTarget(IWDNavigationTargetReferenceInfo navigationTarget) Deletes a navigation target.
void	deleteViewContainerAssignment(IWDViewContainerAssignmentInfo object) Deletes a view container assignment in this view usage.
IWDViewContainerAssignmentInfo	findInViewContainerAssignments(java.lang.String name) Getter for element with given name in 1:n aggregation ViewContainerAssignments.
IWDComponentUsageInfo	getComponentUsage() Getter for 1:1 association ComponentUsage.
IWDViewContainerAssignmentInfo	getEmbeddingViewContainerAssignment() Getter for 1:1 association EmbeddingViewContainerAssignment.
java.lang.String	getId() Getter for writable property id.
int	getNavigationLinkCount() Deprecated. To avoid potential naming conflicts, this method has been renamed to countOfNavigationLinks(). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.
java.util.Collection	getNavigationLinks() Getter for 1:n association NavigationLinks.
IWDAbstractViewInfo	getView() Getter for 1:1 association View.
IWDViewContainerAssignmentInfo	getViewContainerAssignment(java.lang.String name) Deprecated. For better consistency and clearer names, this method has been superceded by findInViewContainerAssignments(String). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.
int	getViewContainerAssignmentCount() Deprecated. To avoid potential naming conflicts, this method has been renamed to countOfViewContainerAssignments(). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.
java.util.Collection	getViewContainerAssignments() Getter for 1:n aggregation ViewContainerAssignments.
IWDWindowInfo	getWindow() Getter for 1:1 association Window.
boolean	hasComponentUsage() Checks whether there is an element in 1:1 association ComponentUsage.
boolean	hasEmbeddingViewContainerAssignment() Checks whether there is an element in 1:1 association EmbeddingViewContainerAssignment.
boolean	hasInNavigationLinks(IWDNavigationLinkInfo o) Checks whether there is an element with the given name in 1:n association NavigationLinks.
boolean	hasInViewContainerAssignments(IWDViewContainerAssignmentInfo o) Checks whether there is an element with the given name in 1:n aggregation ViewContainerAssignments.
boolean	hasInViewContainerAssignments(java.lang.String name) Checks whether there is an element with the given name in 1:n aggregation ViewContainerAssignments.
boolean	hasNavigationLink(IWDNavigationLinkInfo object) Deprecated. For better consistency and clearer names, this method has been superceded by hasInNavigationLinks(...) methods. The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.
boolean	hasView() Checks whether there is an element in 1:1 association View.
boolean	hasViewContainerAssignment(java.lang.String name) Deprecated. For better consistency and clearer names, this method has been superceded by hasInViewContainerAssignments(...) methods. The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.
boolean	hasWindow() Checks whether there is an element in 1:1 association Window.
void	setComponentUsage(IWDComponentUsageInfo object) Sets the component usage of this view usage.
void	setView(IWDAbstractViewInfo object) Sets the view of this view usage.

Methods inherited from interface com.sap.tc.webdynpro.repository.api.IWDRepositoryModelClass

createRelatedModelObject, createRelatedModelObject, deleteRelatedModelObject, getAttributeValue, getName, getParent, getPersonalizationObject, getRepositoryModel, getRepositoryRoot, isVersionableModelObject, setAttributeValue

Methods inherited from interface com.sap.tc.cmi.model.ICMIGenericModelClass

addRelatedModelObject, associatedModelClassInfo, getAttributeValue, getRelatedModelObject, getRelatedModelObjects, removeRelatedModelObject, setAttributeValue, setRelatedModelObject, setRelatedModelObjects

Methods inherited from interface com.sap.tc.cmi.model.ICMIModelClass

associatedModel

Method Detail

getId

public java.lang.String getId()

Getter for writable property id.

Returns:

value of the Property

getComponentUsage

public IWDComponentUsageInfo getComponentUsage()

Getter for 1:1 association ComponentUsage.

Returns:

value of the Relation Role

hasComponentUsage

public boolean hasComponentUsage()

Checks whether there is an element in 1:1 association ComponentUsage.

getEmbeddingViewContainerAssignment

public IWDViewContainerAssignmentInfo getEmbeddingViewContainerAssignment()

Getter for 1:1 association EmbeddingViewContainerAssignment.

Returns:

value of the Relation Role

hasEmbeddingViewContainerAssignment

public boolean hasEmbeddingViewContainerAssignment()

Checks whether there is an element in 1:1 association EmbeddingViewContainerAssignment.

getView

public IWDAbstractViewInfo getView()

Getter for 1:1 association View.

Returns:

value of the Relation Role

hasView

public boolean hasView()

Checks whether there is an element in 1:1 association View.

getWindow

public IWDWindowInfo getWindow()

Getter for 1:1 association Window.

Returns:

value of the Relation Role

hasWindow

public boolean hasWindow()

Checks whether there is an element in 1:1 association Window.

getNavigationLinks

public java.util.Collection getNavigationLinks()

Getter for 1:n association NavigationLinks.

Returns:

java.util.Collection containing elements of the Relation Role

countOfNavigationLinks

public int countOfNavigationLinks()

Determine number of elements in 1:n association NavigationLinks.

getNavigationLinkCount

public int getNavigationLinkCount()

Deprecated. To avoid potential naming conflicts, this method has been renamed to countOfNavigationLinks(). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.

Determine number of elements in 1:n association NavigationLinks.

hasNavigationLink

public boolean hasNavigationLink(IWDNavigationLinkInfo object)

Deprecated. For better consistency and clearer names, this method has been superceded by hasInNavigationLinks(...) methods. The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.

Checks whether there is an element with the given name in 1:n association NavigationLinks.

hasInNavigationLinks

public boolean hasInNavigationLinks(IWDNavigationLinkInfo o)

Checks whether there is an element with the given name in 1:n association NavigationLinks.

getViewContainerAssignments

public java.util.Collection getViewContainerAssignments()

Getter for 1:n aggregation ViewContainerAssignments.

Returns:

java.util.Collection containing elements of the Relation Role

countOfViewContainerAssignments

public int countOfViewContainerAssignments()

Determine number of elements in 1:n aggregation ViewContainerAssignments.

getViewContainerAssignmentCount

public int getViewContainerAssignmentCount()

Deprecated. To avoid potential naming conflicts, this method has been renamed to countOfViewContainerAssignments(). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.

Determine number of elements in 1:n aggregation ViewContainerAssignments.

getViewContainerAssignment

public IWDViewContainerAssignmentInfo getViewContainerAssignment(java.lang.String name)

Deprecated. For better consistency and clearer names, this method has been superceded by findInViewContainerAssignments(String). The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.

Getter for element with given name in 1:n aggregation ViewContainerAssignments.

hasViewContainerAssignment

public boolean hasViewContainerAssignment(java.lang.String name)

Deprecated. For better consistency and clearer names, this method has been superceded by hasInViewContainerAssignments(...) methods. The method with the old name has been kept for backward compatibility only and may be withdrawn with the first new NetWeaver release in 2006.

Checks whether there is an element with the given name in 1:n aggregation ViewContainerAssignments.

hasInViewContainerAssignments

public boolean hasInViewContainerAssignments(IWDViewContainerAssignmentInfo o)

Checks whether there is an element with the given name in 1:n aggregation ViewContainerAssignments.

findInViewContainerAssignments

public IWDViewContainerAssignmentInfo findInViewContainerAssignments(java.lang.String name)

Getter for element with given name in 1:n aggregation ViewContainerAssignments.

hasInViewContainerAssignments

public boolean hasInViewContainerAssignments(java.lang.String name)

Checks whether there is an element with the given name in 1:n aggregation ViewContainerAssignments.

deleteViewContainerAssignment

public void deleteViewContainerAssignment(IWDViewContainerAssignmentInfo object)

Deletes a view container assignment in this view usage.

Parameters:

object - the view container assignment to delete

setComponentUsage

public void setComponentUsage(IWDComponentUsageInfo object)

Sets the component usage of this view usage.

Parameters:

object - the new component usage

createViewContainerAssignment

public IWDViewContainerAssignmentInfo createViewContainerAssignment()

Creates a new view container assignment in this view usage.

Returns:

the newly created view container assignment

deleteAllNavigationTargets

public void deleteAllNavigationTargets(java.lang.String sourcePlugName)

Deletes all navigation targets of an outbound plug.

Parameters:

sourcePlugName - name of the outbound plug

createNavigationTarget

public IWDNavigationTargetReferenceInfo createNavigationTarget(java.lang.String sourcePlugName,
                                                               IWDViewUsageInfo targetViewUsage,
                                                               java.lang.String targetPlugName)

Creates a new navigation target

Parameters:

sourcePlugName - name of the outbound plug of this view usage

targetViewUsage - navigation target view usage

targetPlugName - name of the inbound plug of the navigation target

deleteNavigationTarget

public void deleteNavigationTarget(IWDNavigationTargetReferenceInfo navigationTarget)

Deletes a navigation target.

Parameters:

navigationTarget - navigation target of this view usage to be deleted

setView

public void setView(IWDAbstractViewInfo object)

Sets the view of this view usage.

Parameters:

object - the new view