IP*Works! V9

ipworks
Class ODataSchemaAssociation

java.lang.Object
  extended by ipworks.ODataSchemaAssociation

public class ODataSchemaAssociation
extends java.lang.Object

An object representing a single OData schema navigation property and its corresponding association.

An object representing a single OData schema navigation property and its corresponding association.

Description: The documentation long description of the OData schema association.

FromRole: The name of the starting point of the navigation.

FromRoleDescription: The documentation long description of the OData schema FromRole association end point.

FromRoleEntity: The name of the entity that FromRole association end point maps to.

FromRoleMultiplicity: The multiplicity of the FromRole association end point. This is used along with ToRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) \011
Zero-One (0..1)
nmOne (1)\011\011\011\011
One (1)
nmMany (2)\011\011\011
Many (*)

FromRoleSummary: The documentation summary of the OData schema FromRole association end point.

Name: The Name of the OData schema navigation property.

OnDelete: The delete action to be performed.

Available values are:

daNone (0)\011\011
Only the specified entry instance within FromRoleEntity is deleted. This is the default value.
daCascade (1)\011
After the specified entry instance is deleted within FromRoleEntity , the action is applied to \011\011\011\011\011\011\011\011\011\011\011the entry instance within the ToRoleEntity . For example, a single Customer is associated with \011\011\011\011\011\011\011\011\011\011\011multiple Orders. When a Customer is deleted, all Orders associated with the Customer will be deleted.

Relationship: The name of the relationship (association) of the navigation property.

Summary: The documentation summary of the OData schema association.

ToRole: The name of the end point of the navigation.

ToRoleDescription: The documentation long description of the OData schema ToRole association end point.

ToRoleEntity: The name of the entity that ToRole association end point maps to.

ToRoleMultiplicity: The multiplicity of the ToRole association end point. This is used along with FromRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) \011
Zero-One (0..1)
nmOne (1)\011\011\011\011
One (1)
nmMany (2)\011\011\011
Many (*)

ToRoleSummary: The documentation summary of the OData schema ToRole association end point.

See Also:
Atom, Atom.ODataSchemaAssociation

Field Summary
static int daCascade
           
static int daNone
           
static int nmMany
           
static int nmOne
           
static int nmZeroOne
           
 
Constructor Summary
ODataSchemaAssociation()
           
 
Method Summary
 java.lang.String getDescription()
           
 java.lang.String getFromRole()
           
 java.lang.String getFromRoleDescription()
           
 java.lang.String getFromRoleEntity()
           
 int getFromRoleMultiplicity()
           
 java.lang.String getFromRoleSummary()
           
 java.lang.String getName()
           
 int getOnDelete()
           
 java.lang.String getRelationship()
           
 java.lang.String getSummary()
           
 java.lang.String getToRole()
           
 java.lang.String getToRoleDescription()
           
 java.lang.String getToRoleEntity()
           
 int getToRoleMultiplicity()
           
 java.lang.String getToRoleSummary()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nmZeroOne

public static final int nmZeroOne
See Also:
Constant Field Values

nmOne

public static final int nmOne
See Also:
Constant Field Values

nmMany

public static final int nmMany
See Also:
Constant Field Values

daNone

public static final int daNone
See Also:
Constant Field Values

daCascade

public static final int daCascade
See Also:
Constant Field Values
Constructor Detail

ODataSchemaAssociation

public ODataSchemaAssociation()
Method Detail

getDescription

public java.lang.String getDescription()

getFromRole

public java.lang.String getFromRole()

getFromRoleDescription

public java.lang.String getFromRoleDescription()

getFromRoleEntity

public java.lang.String getFromRoleEntity()

getFromRoleMultiplicity

public int getFromRoleMultiplicity()

getFromRoleSummary

public java.lang.String getFromRoleSummary()

getName

public java.lang.String getName()

getOnDelete

public int getOnDelete()

getRelationship

public java.lang.String getRelationship()

getSummary

public java.lang.String getSummary()

getToRole

public java.lang.String getToRole()

getToRoleDescription

public java.lang.String getToRoleDescription()

getToRoleEntity

public java.lang.String getToRoleEntity()

getToRoleMultiplicity

public int getToRoleMultiplicity()

getToRoleSummary

public java.lang.String getToRoleSummary()

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.