bdd0a41aed
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@668359 13f79535-47bb-0310-9956-ffa450edef68
330 lines
15 KiB
HTML
330 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.5.0) on Wed Dec 05 13:51:34 GMT 2007 -->
|
|
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<TITLE>
|
|
Property (com.agfa.hap.sdo 2.15.0-for-apache-SNAPSHOT API)
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="com.agfa.hap.sdo.Property interface">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="Property (com.agfa.hap.sdo 2.15.0-for-apache-SNAPSHOT API)";
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Property.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../com/agfa/hap/sdo/PartialDataObject.html" title="interface in com.agfa.hap.sdo"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../com/agfa/hap/sdo/PropertyNotAvailableException.html" title="class in com.agfa.hap.sdo"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?com/agfa/hap/sdo/Property.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Property.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<A NAME="main"></A>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
com.agfa.hap.sdo</FONT>
|
|
<BR>
|
|
Interface Property</H2>
|
|
<DL>
|
|
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>Property</B><DT>extends <A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
A representation of a Property in the <A HREF="../../../../com/agfa/hap/sdo/Type.html" title="interface in com.agfa.hap.sdo"><CODE>type</CODE></A> of a <CODE>data object</CODE>.
|
|
|
|
We extend <A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo"><CODE>Property</CODE></A> to have type safety (through generics) and to
|
|
add functionality such as <A HREF="../../../../com/agfa/hap/sdo/Property.html#getIndex()"><CODE>getIndex()</CODE></A>.
|
|
<P>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List<java.lang.String></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/agfa/hap/sdo/Property.html#getAliasNames()">getAliasNames</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return a list of alias names for this Property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../com/agfa/hap/sdo/Type.html" title="interface in com.agfa.hap.sdo">Type</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/agfa/hap/sdo/Property.html#getContainingType()">getContainingType</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the containing type of this Property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/agfa/hap/sdo/Property.html#getIndex()">getIndex</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the index in the list of properties of its containingtype.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../com/agfa/hap/sdo/Property.html" title="interface in com.agfa.hap.sdo">Property</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/agfa/hap/sdo/Property.html#getOpposite()">getOpposite</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the opposite Property if the Property is bi-directional or null otherwise.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../com/agfa/hap/sdo/Type.html" title="interface in com.agfa.hap.sdo">Type</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/agfa/hap/sdo/Property.html#getType()">getType</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the type of the Property.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_commonj.sdo.Property"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from interface commonj.sdo.<A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="../../../../commonj/sdo/Property.html#get(commonj.sdo.Property)">get</A>, <A HREF="../../../../commonj/sdo/Property.html#getDefault()">getDefault</A>, <A HREF="../../../../commonj/sdo/Property.html#getInstanceProperties()">getInstanceProperties</A>, <A HREF="../../../../commonj/sdo/Property.html#getName()">getName</A>, <A HREF="../../../../commonj/sdo/Property.html#isContainment()">isContainment</A>, <A HREF="../../../../commonj/sdo/Property.html#isMany()">isMany</A>, <A HREF="../../../../commonj/sdo/Property.html#isNullable()">isNullable</A>, <A HREF="../../../../commonj/sdo/Property.html#isOpenContent()">isOpenContent</A>, <A HREF="../../../../commonj/sdo/Property.html#isReadOnly()">isReadOnly</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="getType()"><!-- --></A><H3>
|
|
getType</H3>
|
|
<PRE>
|
|
<A HREF="../../../../com/agfa/hap/sdo/Type.html" title="interface in com.agfa.hap.sdo">Type</A> <B>getType</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the type of the Property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../commonj/sdo/Property.html#getType()">getType</A></CODE> in interface <CODE><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the Property type.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getContainingType()"><!-- --></A><H3>
|
|
getContainingType</H3>
|
|
<PRE>
|
|
<A HREF="../../../../com/agfa/hap/sdo/Type.html" title="interface in com.agfa.hap.sdo">Type</A> <B>getContainingType</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the containing type of this Property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../commonj/sdo/Property.html#getContainingType()">getContainingType</A></CODE> in interface <CODE><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the Property's containing type.<DT><B>See Also:</B><DD><A HREF="../../../../com/agfa/hap/sdo/Type.html#getProperties()"><CODE>Type.getProperties()</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getOpposite()"><!-- --></A><H3>
|
|
getOpposite</H3>
|
|
<PRE>
|
|
<A HREF="../../../../com/agfa/hap/sdo/Property.html" title="interface in com.agfa.hap.sdo">Property</A> <B>getOpposite</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the opposite Property if the Property is bi-directional or null otherwise.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../commonj/sdo/Property.html#getOpposite()">getOpposite</A></CODE> in interface <CODE><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the opposite Property if the Property is bi-directional or null</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAliasNames()"><!-- --></A><H3>
|
|
getAliasNames</H3>
|
|
<PRE>
|
|
java.util.List<java.lang.String> <B>getAliasNames</B>()</PRE>
|
|
<DL>
|
|
<DD>Return a list of alias names for this Property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../commonj/sdo/Property.html#getAliasNames()">getAliasNames</A></CODE> in interface <CODE><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a list of alias names for this Property.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getIndex()"><!-- --></A><H3>
|
|
getIndex</H3>
|
|
<PRE>
|
|
int <B>getIndex</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the index in the list of properties of its containingtype.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../commonj/sdo/Property.html#getIndex()">getIndex</A></CODE> in interface <CODE><A HREF="../../../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD><DT><B>See Also:</B><DD><A HREF="../../../../commonj/sdo/Type.html#getProperties()"><CODE>Type.getProperties()</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Property.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../com/agfa/hap/sdo/PartialDataObject.html" title="interface in com.agfa.hap.sdo"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../com/agfa/hap/sdo/PropertyNotAvailableException.html" title="class in com.agfa.hap.sdo"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?com/agfa/hap/sdo/Property.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Property.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2007. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|