BSMiscellaneousQueries.java
001 //
002 // This file is generated by MetaBoss Ver 1.4.0001 at Thu Dec 15 22:36:23 EST 2005
003 // MetaBoss is Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
004 // Content of this file is Copyright 2000-2005 © Softaris Pty. Ltd. All Rights Reserved.
005 // This content is licensed under Open Source Gnu Public License (GPL)
006 // Full terms and conditions of GPL can be found found at www.gnu.org
007 //
008 package com.almamater.crs.services.reporting;
009 
010 import java.io.Serializable;
011 import com.metaboss.enterprise.bs.BSObject;
012 import com.metaboss.enterprise.bs.BSException;
013 import com.metaboss.enterprise.bs.STBusinessServiceOperationInput;
014 import com.metaboss.enterprise.bs.STBusinessServiceOperationResult;
015 
016   /**  Service description is: <i>Various custom made queries</i>.
017   *<p>This inderface represents the Enterprise/systems[CRS]/servicemodules[Reporting]/services[MiscellaneousQueries] service.</p>
018   */
019 public interface BSMiscellaneousQueries extends BSObject
020 {
021     /** Naming URL of the instances of this component. Used to access it via JNDI */
022     public static final String COMPONENT_URL = "component:/com.almamater.crs.services.reporting.BSMiscellaneousQueries";
023 
024     /** This structure carries the input arguments to the findFreeTeachers operation. 
025       *<P><I><U>Field values note.</U> If field is null - it is interpreted as "not specified by client" or "not retrieved from the storage"
026       * Compare this to the empty instance or zero length array - they are interpreted as specified or retrieved empty data value
027       * For example if null field is submitted for update operation - it will be ignored and value in storage will not be changed
028       * On the other hand if empty instance or zero-length array is submitted for update operation - the values in storage will be updated accordingly</I> */
029     public final class STFindFreeTeachersInput extends STBusinessServiceOperationInput implements Serializable
030     {
031    /** @return true if this structure is empty */
032    public boolean isEmpty()
033    {
034        return true;
035    }
036     }
037 
038     /** This structure carries the result of the findFreeTeachers operation. 
039       *<P><I><U> Field values note.</U> If field is null - it is interpreted as "not specified by client" or "not retrieved from the storage"
040       * Compare this to the empty instance or zero length array - they are interpreted as specified or retrieved empty data value
041       * For example if null field is submitted for update operation - it will be ignored and value in storage will not be changed
042       * On the other hand if empty instance or zero-length array is submitted for update operation - the values in storage will be updated accordingly</I> */
043     public final class STFindFreeTeachersResult extends STBusinessServiceOperationResult implements Serializable
044     {
045         private com.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] mFreeTeachers = null;
046    /** @return true if this structure is empty */
047    public boolean isEmpty()
048    {
049        return mFreeTeachers == null;
050    }
051 
052         /** Getter for the FreeTeachers field.
053           * Field description is: <i>Details of Teachers who are not associated with any Course</i>
054           @return the value of the FreeTeachers field */
055         public com.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] getFreeTeachers()
056         {
057             return mFreeTeachers;
058         }
059 
060         /** Setter for the FreeTeachers field.
061           * Field description is: <i>Details of Teachers who are not associated with any Course</i>
062           @param pFreeTeachers the new value of the field */
063         public void setFreeTeacherscom.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] pFreeTeachers)
064         {
065             mFreeTeachers = pFreeTeachers;
066         }
067     }
068 
069     /** Operation description is: <i>Find Teachers who are not assigned to any Course.</i>
070      *<p>This method represents the Enterprise/systems[CRS]/servicemodules[Reporting]/services[MiscellaneousQueries]/operations[findFreeTeachers] operation.</p>
071      */
072     public STFindFreeTeachersResult findFreeTeachersSTFindFreeTeachersInput pInputthrows BSException;
073 
074     /** This structure carries the input arguments to the findStudentAcquaintances operation. 
075       *<P><I><U>Field values note.</U> If field is null - it is interpreted as "not specified by client" or "not retrieved from the storage"
076       * Compare this to the empty instance or zero length array - they are interpreted as specified or retrieved empty data value
077       * For example if null field is submitted for update operation - it will be ignored and value in storage will not be changed
078       * On the other hand if empty instance or zero-length array is submitted for update operation - the values in storage will be updated accordingly</I> */
079     public final class STFindStudentAcquaintancesInput extends STBusinessServiceOperationInput implements Serializable
080     {
081        private com.almamater.crs.services.coursesdomainsupport.STStudentKey mStudent = null;
082    /** @return true if this structure is empty */
083    public boolean isEmpty()
084    {
085        return mStudent == null;
086    }
087 
088         /** Getter for the Student field.
089           * Field description is: <i>Identifier of the Student to find acquaintances for</i>
090           @return the value of the Student field */
091         public com.almamater.crs.services.coursesdomainsupport.STStudentKey getStudent()
092         {
093             return mStudent;
094         }
095 
096         /** Setter for the Student field.
097           * Field description is: <i>Identifier of the Student to find acquaintances for</i>
098           @param pStudent the new value of the field */
099         public void setStudentcom.almamater.crs.services.coursesdomainsupport.STStudentKey pStudent)
100         {
101             mStudent = pStudent;
102         }
103     }
104 
105     /** This structure carries the result of the findStudentAcquaintances operation. 
106       *<P><I><U> Field values note.</U> If field is null - it is interpreted as "not specified by client" or "not retrieved from the storage"
107       * Compare this to the empty instance or zero length array - they are interpreted as specified or retrieved empty data value
108       * For example if null field is submitted for update operation - it will be ignored and value in storage will not be changed
109       * On the other hand if empty instance or zero-length array is submitted for update operation - the values in storage will be updated accordingly</I> */
110     public final class STFindStudentAcquaintancesResult extends STBusinessServiceOperationResult implements Serializable
111     {
112         private com.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] mTeachers = null;
113         private com.almamater.crs.services.coursesdomainsupport.STStudentDetails[] mStudents = null;
114         private com.almamater.crs.services.coursesdomainsupport.MOStudentInstanceNotFoundError mStudentNotFoundError = null;
115         private com.almamater.types.core.MOInvalidOperationInputError mInvalidOperationInputError = null;
116    /** @return true if this structure is empty */
117    public boolean isEmpty()
118    {
119        return mTeachers == null && mStudents == null && mStudentNotFoundError == null && mInvalidOperationInputError == null;
120    }
121 
122         /** Getter for the Teachers field.
123           * Field description is: <i>Details of Teachers who are familiar with the given Student</i>
124           @return the value of the Teachers field */
125         public com.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] getTeachers()
126         {
127             return mTeachers;
128         }
129 
130         /** Setter for the Teachers field.
131           * Field description is: <i>Details of Teachers who are familiar with the given Student</i>
132           @param pTeachers the new value of the field */
133         public void setTeacherscom.almamater.crs.services.coursesdomainsupport.STTeacherDetails[] pTeachers)
134         {
135             mTeachers = pTeachers;
136         }
137 
138         /** Getter for the Students field.
139           * Field description is: <i>Details of Students who are familiar with the given Student</i>
140           @return the value of the Students field */
141         public com.almamater.crs.services.coursesdomainsupport.STStudentDetails[] getStudents()
142         {
143             return mStudents;
144         }
145 
146         /** Setter for the Students field.
147           * Field description is: <i>Details of Students who are familiar with the given Student</i>
148           @param pStudents the new value of the field */
149         public void setStudentscom.almamater.crs.services.coursesdomainsupport.STStudentDetails[] pStudents)
150         {
151             mStudents = pStudents;
152         }
153 
154         /** Getter for the StudentNotFoundError message.
155           * Message field description is: <i>Contains error message in case if specified Student does not exist.</i>
156           * Message description is: <i>This error indicates that operation has failed because required Student instance was not found.</i>
157           @return the StudentNotFoundError field or null */
158         public com.almamater.crs.services.coursesdomainsupport.MOStudentInstanceNotFoundError getStudentNotFoundError()
159         {
160             return mStudentNotFoundError;
161         }
162 
163         /** Setter for the StudentNotFoundError field.
164           * Message field description is: <i>Contains error message in case if specified Student does not exist.</i>
165           * Message description is: <i>This error indicates that operation has failed because required Student instance was not found.</i>
166           @param pStudentNotFoundError the new value of the message. Use null to clear the old messages out */
167         public void setStudentNotFoundErrorcom.almamater.crs.services.coursesdomainsupport.MOStudentInstanceNotFoundError pStudentNotFoundError)
168         {
169             mStudentNotFoundError = pStudentNotFoundError;
170         }
171 
172         /** Getter for the InvalidOperationInputError message.
173           * Message field description is: <i>This error message indicates that operation has failed because it was invoked with invalid combination of input fields. In other words it indicates that the input data validation constraint has been violated.</i>
174           * Message description is: <i>This error message indicates that operation has failed because it was invoked with invalid combination of input fields. In other words it indicates that the input data validation constraint has been violated.</i>
175           @return the InvalidOperationInputError field or null */
176         public com.almamater.types.core.MOInvalidOperationInputError getInvalidOperationInputError()
177         {
178             return mInvalidOperationInputError;
179         }
180 
181         /** Setter for the InvalidOperationInputError field.
182           * Message field description is: <i>This error message indicates that operation has failed because it was invoked with invalid combination of input fields. In other words it indicates that the input data validation constraint has been violated.</i>
183           * Message description is: <i>This error message indicates that operation has failed because it was invoked with invalid combination of input fields. In other words it indicates that the input data validation constraint has been violated.</i>
184           @param pInvalidOperationInputError the new value of the message. Use null to clear the old messages out */
185         public void setInvalidOperationInputErrorcom.almamater.types.core.MOInvalidOperationInputError pInvalidOperationInputError)
186         {
187             mInvalidOperationInputError = pInvalidOperationInputError;
188         }
189         /** Overridden to return list of contained mesages. */
190         protected java.util.List getContainedMessages()
191         {
192             java.util.List lReturnList = super.getContainedMessages();
193             if (mStudentNotFoundError != null)
194                 lReturnList.add(mStudentNotFoundError);
195             if (mInvalidOperationInputError != null)
196                 lReturnList.add(mInvalidOperationInputError);
197             return lReturnList;
198         }
199     }
200 
201     /** Operation description is: <i>Find all Students and Teachers who are familiar with the given Student.</i>
202      *<p>This method represents the Enterprise/systems[CRS]/servicemodules[Reporting]/services[MiscellaneousQueries]/operations[findStudentAcquaintances] operation.</p>
203      */
204     public STFindStudentAcquaintancesResult findStudentAcquaintancesSTFindStudentAcquaintancesInput pInputthrows BSException;
205 }