001: package com.ibm.emb.meb.wrapper;
002:
003: import javax.ejb.CreateException;
004: import javax.ejb.FinderException;
005: import javax.ejb.RemoveException;
006: import javax.emb.MediaException;
007: import javax.emb.MediaFormat;
008: import javax.naming.NamingException;
009:
010: /**
011: * Remote interface for Enterprise Bean: MetaDataEntityWrapper
012: */
013: public interface MetaDataEntityWrapper extends javax.ejb.EJBObject {
014:
015: public static int NULLPOINTER = 1;
016:
017: public static int MEDIAFORMAT = 2;
018:
019: public static int MALFORMEDURL = 3;
020:
021: public static int CONTENTACCESS = 4;
022:
023: public static int MALFORMEDQUERY = 5;
024:
025: public static int UNSUPPORTEDQUERY = 6;
026:
027: public static int ILLEGALOPTION = 7;
028:
029: public static int XMLVALIDATION = 8;
030:
031: /*
032: * MetaDataEntityLocal Wrapped Methods
033: */
034:
035: /**
036: * Invokes addMediaEntity(MediaEntityLocal) on the MetaDataEntityLocal The
037: * primary key passed will first be resolved to a MetaDataEntityBean on
038: * which the operation should be invoked on. If the media primary key is not
039: * null, it will be resolved to a MediaEntityBean before it is passed in to
040: * the method. If the child is null, null is passed in.
041: * @param pk - String representing the primary key of the MetaDataEntityBean
042: * to invoke the operation on
043: * @param childpk - String representing the primary key of the media
044: * MediaEntityLocal
045: * @exception NullPointerException - thrown if the primary key passed in is
046: * null
047: * @exception MediaException thrown if the exception was thrown by the
048: * MetaDataEntityLocal operation
049: * @exception NamingException thrown if there are problems looking up the
050: * MetaDataEntityLocalHome
051: * @exception FinderException thrown if either primary key can not be found
052: * in the datastore
053: */
054: public void addMetaDataMedia(String pk, String mediapk)
055: throws MediaException, NamingException, FinderException,
056: java.rmi.RemoteException;
057:
058: /**
059: * Invokes getMediaEntities(MediaFormat, boolean) on the MetaDataEntityLocal
060: * The primary key passed will first be resolved to a MetaDataEntityBean on
061: * which the operation should be invoked on.
062: * @param pk - String representing the primary key of the MetaDataEntityBean
063: * to invoke the operation on
064: * @param format - MediaFormat object to be passed
065: * @param recursive - if true, children are searched too
066: * @exception NullPointerException - thrown if the primary key passed in is
067: * null
068: * @exception MediaException thrown if the exception was thrown by the
069: * MetaDataEntityLocal operation
070: * @exception NamingException thrown if there are problems looking up the
071: * MetaDataEntityLocalHome
072: * @exception FinderException thrown if either primary key can not be found
073: * in the datastore
074: */
075: public String[] getMetaDataEntityMediaEntities(String pk,
076: MediaFormat format, boolean searchChildren)
077: throws MediaException, NamingException, FinderException,
078: java.rmi.RemoteException;
079:
080: /**
081: * Invokes addChild(MetaDataEntityLocal) on the MetaDataEntityLocal The
082: * primary key passed will first be resolved to a MetaDataEntityBean on
083: * which the operation should be invoked on. If the child primary key is not
084: * null, it will be resolved to a MetaDataEntityBean before it is passed in
085: * to the method. If the child is null, null is passed in.
086: * @param pk - String representing the primary key of the MetaDataEntityBean
087: * to invoke the operation on
088: * @param childpk - String representing the primary key of the child
089: * MetaDataEntityLocal
090: * @exception NullPointerException - thrown if the primary key passed in is
091: * null
092: * @exception MediaException thrown if the exception was thrown by the
093: * MetaDataEntityLocal operation
094: * @exception NamingException thrown if there are problems looking up the
095: * MetaDataEntityLocalHome
096: * @exception FinderException thrown if either primary key can not be found
097: * in the datastore
098: */
099: public void addMetaDataChild(String pk, String childpk)
100: throws MediaException, NamingException, FinderException,
101: java.rmi.RemoteException;
102:
103: /**
104: * Invokes getMediaEntities(MediaFormat, boolean) on the MetaDataEntityLocal
105: * The primary key passed will first be resolved to a MetaDataEntityBean on
106: * which the operation should be invoked on.
107: * @param pk - String representing the primary key of the MetaDataEntityBean
108: * to invoke the operation on
109: * @param mimeType - String representing the mime type to be passed
110: * @param recursive - if true, children are searched too
111: * @exception NullPointerException - thrown if the primary key passed in is
112: * null
113: * @exception MediaException thrown if the exception was thrown by the
114: * MetaDataEntityLocal operation
115: * @exception NamingException thrown if there are problems looking up the
116: * MetaDataEntityLocalHome
117: * @exception FinderException thrown if either primary key can not be found
118: * in the datastore
119: */
120: public String[] getMetaDataEntityMediaEntities(String pk,
121: String mimeType, boolean searchChildren)
122: throws MediaException, NamingException, FinderException,
123: java.rmi.RemoteException;
124:
125: /**
126: * Invokes getChildren() on the MetaDataEntityLocal The primary key passed
127: * will first be resolved to a MetaDataEntityBean on which the operation
128: * should be invoked on. The array of MetaDataEntityBean children will first
129: * be converted into an array of primary keys representing the children
130: * before being returned.
131: * @param pk - String representing the primary key of the MetaDataEntityBean
132: * to invoke the operation on
133: * @return String array of primary keys representing the children on the
134: * MetaDataEntityBean
135: * @exception NullPointerException - thrown if the primary key passed in is
136: * null
137: * @exception MediaException thrown if the exception was thrown by the
138: * MetaDataEntityLocal operation
139: * @exception NamingException thrown if there are problems looking up the
140: * MetaDataEntityLocalHome
141: * @exception FinderException thrown if the primary key can not be found in
142: * the datastore
143: */
144: public String[] getMetaDataEntityChildren(String pk)
145: throws NamingException, FinderException, MediaException,
146: java.rmi.RemoteException;
147:
148: /**
149: * Invokes getLastModified() on the MetaDataEntityLocal The primary key
150: * passed will first be resolved to a MetaDataEntityBean on which the
151: * operation should be invoked on.
152: * @param pk - String representing the primary key of the MetaDataEntityBean
153: * to invoke the operation on
154: * @return long representing the timestamp of when MetaDataEntityBean was
155: * last modified
156: * @exception NullPointerException - thrown if the primary key passed in is
157: * null
158: * @exception MediaException thrown if the exception was thrown by the
159: * MetaDataEntityLocal operation
160: * @exception NamingException thrown if there are problems looking up the
161: * MetaDataEntityLocalHome
162: * @exception FinderException thrown if the primary key can not be found in
163: * the datastore
164: */
165: public long getMetaDataEntityLastModified(String pk)
166: throws NamingException, FinderException, MediaException,
167: java.rmi.RemoteException;
168:
169: /**
170: * Invokes getMediaEntities() on the MetaDataEntityLocal The primary key
171: * passed will first be resolved to a MetaDataEntityBean on which the
172: * operation should be invoked on. The array of MediaEntity children is
173: * converted into an array of primary keys representing the children before
174: * being returned.
175: * @param pk - String representing the primary key of the MetaDataEntityBean
176: * to invoke the operation on
177: * @return String array of primary keys representing the associated
178: * MediaEntityBeans
179: * @exception NullPointerException - thrown if the primary key passed in is
180: * null
181: * @exception MediaException thrown if the exception was thrown by the
182: * MetaDataEntityLocal operation
183: * @exception NamingException thrown if there are problems looking up the
184: * MetaDataEntityLocalHome
185: * @exception FinderException thrown if the primary key can not be found in
186: * the datastore
187: */
188: public String[] getMetaDataEntityMediaEntities(String pk)
189: throws NamingException, FinderException, MediaException,
190: java.rmi.RemoteException;
191:
192: /**
193: * Invokes getName() on the MetaDataEntityLocal The primary key passed will
194: * first be resolved to a MetaDataEntityBean on which the operation should
195: * be invoked on.
196: * @param pk - String representing the primary key of the MetaDataEntityBean
197: * to invoke the operation on
198: * @return String representing the name of the MetaDataEntityBean
199: * @exception NullPointerException - thrown if the primary key passed in is
200: * null
201: * @exception MediaException thrown if the exception was thrown by the
202: * MetaDataEntityLocal operation
203: * @exception NamingException thrown if there are problems looking up the
204: * MetaDataEntityLocalHome
205: * @exception FinderException thrown if the primary key can not be found in
206: * the datastore
207: */
208: public String getMetaDataEntityName(String pk)
209: throws NamingException, FinderException, MediaException,
210: java.rmi.RemoteException;
211:
212: /**
213: * Invokes getNextVersion() on the MetaDataEntityLocal The primary key
214: * passed will first be resolved to a MetaDataEntityBean on which the
215: * operation should be invoked on. The primary key of the
216: * MetaDataEntityBean's next version MetaDataEntityBean will be returned or
217: * null if the next version is null.
218: * @param pk - String representing the primary key of the MetaDataEntityBean
219: * to invoke the operation on
220: * @return String representing the primary key of the MetaDataEntityBean's
221: * next version or null
222: * @exception NullPointerException - thrown if the primary key passed in is
223: * null
224: * @exception MediaException thrown if the exception was thrown by the
225: * MetaDataEntityLocal operation
226: * @exception NamingException thrown if there are problems looking up the
227: * MetaDataEntityLocalHome
228: * @exception FinderException thrown if the primary key can not be found in
229: * the datastore
230: */
231: public String getMetaDataEntityNextVersion(String pk)
232: throws NamingException, FinderException, MediaException,
233: java.rmi.RemoteException;
234:
235: /**
236: * Invokes getParents() on the MetaDataEntityLocal The primary key passed
237: * will first be resolved to a MetaDataEntityBean on which the operation
238: * should be invoked on. The array of MetaDataEntityBean parents will first
239: * be converted into an array of primary keys representing the parents
240: * before being returned.
241: * @param pk - String representing the primary key of the MetaDataEntityBean
242: * to invoke the operation on
243: * @return String array of primary keys representing the parents on the
244: * MetaDataEntityBean
245: * @exception NullPointerException - thrown if the primary key passed in is
246: * null
247: * @exception MediaException thrown if the exception was thrown by the
248: * MetaDataEntityLocal operation
249: * @exception NamingException thrown if there are problems looking up the
250: * MetaDataEntityLocalHome
251: * @exception FinderException thrown if the primary key can not be found in
252: * the datastore
253: */
254: public String[] getMetaDataEntityParents(String pk)
255: throws NamingException, FinderException, MediaException,
256: java.rmi.RemoteException;
257:
258: /**
259: * Invokes getPreviousVersion() on the MetaDataEntityLocal The primary key
260: * passed will first be resolved to a MetaDataEntityBean on which the
261: * operation should be invoked on. The primary key of the
262: * MetaDataEntityBean's previous version MetaDataEntityBean will be returned
263: * or null if the next version is null.
264: * @param pk - String representing the primary key of the MetaDataEntityBean
265: * to invoke the operation on
266: * @return String representing the primary key of the MetaDataEntityBean's
267: * previous version or null
268: * @exception NullPointerException - thrown if the primary key passed in is
269: * null
270: * @exception MediaException thrown if the exception was thrown by the
271: * MetaDataEntityLocal operation
272: * @exception NamingException thrown if there are problems looking up the
273: * MetaDataEntityLocalHome
274: * @exception FinderException thrown if the primary key can not be found in
275: * the datastore
276: */
277: public String getMetaDataEntityPreviousVersion(String pk)
278: throws NamingException, FinderException, MediaException,
279: java.rmi.RemoteException;
280:
281: /**
282: * Invokes getXML(String) on the MetaDataEntityLocal The primary key passed
283: * will first be resolved to a MetaDataEntityBean on which the operation
284: * should be invoked on.
285: * @param pk - String representing the primary key of the MetaDataEntityBean
286: * to invoke the operation on
287: * @exception NullPointerException - thrown if the primary key passed in is
288: * null
289: * @throws MediaException thrown if the exception was thrown by the
290: * MetaDataEntityLocal operation
291: * @throws NamingException thrown if there are problems looking up the
292: * MetaDataEntityLocalHome
293: * @throws FinderException thrown if either primary key can not be found in
294: * the datastore
295: */
296: public String getMetaDataEntityXML(String pk)
297: throws MediaException, NamingException, FinderException,
298: java.rmi.RemoteException;
299:
300: /**
301: * Invokes removeChild(MetaDataEntityLocal) on the MetaDataEntityLocal The
302: * primary key passed will first be resolved to a MetaDataEntityBean on
303: * which the operation should be invoked on. If the child primary key is not
304: * null, it will be resolved to a MetaDataEntityBean before it is passed in
305: * to the method. If the child is null, null is passed in.
306: * @param pk - String representing the primary key of the MetaDataEntityBean
307: * to invoke the operation on
308: * @param childpk - String representing the primary key of the child
309: * MetaDataEntityLocal
310: * @exception NullPointerException - thrown if the primary key passed in is
311: * null
312: * @exception MediaException thrown if the exception was thrown by the
313: * MetaDataEntityLocal operation
314: * @exception NamingException thrown if there are problems looking up the
315: * MetaDataEntityLocalHome
316: * @exception FinderException thrown if either primary key can not be found
317: * in the datastore
318: */
319: public void removeMetaDataChild(String pk, String childpk)
320: throws MediaException, NamingException, FinderException,
321: java.rmi.RemoteException;
322:
323: /**
324: * Invokes removeMediaEntity(MediaEntityLocal) on the MetaDataEntityLocal
325: * The primary key passed will first be resolved to a MetaDataEntityBean on
326: * which the operation should be invoked on. If the media primary key is not
327: * null, it will be resolved to a MediaEntityBean before it is passed in to
328: * the method. If the child is null, null is passed in.
329: * @param pk - String representing the primary key of the MetaDataEntityBean
330: * to invoke the operation on
331: * @param childpk - String representing the primary key of the media
332: * MediaEntityLocal
333: * @exception NullPointerException - thrown if the primary key passed in is
334: * null
335: * @exception MediaException thrown if the exception was thrown by the
336: * MetaDataEntityLocal operation
337: * @exception NamingException thrown if there are problems looking up the
338: * MetaDataEntityLocalHome
339: * @exception FinderException thrown if either primary key can not be found
340: * in the datastore
341: */
342: public void removeMetaDataMedia(String pk, String mediapk)
343: throws MediaException, NamingException, FinderException,
344: java.rmi.RemoteException;
345:
346: /**
347: * Invokes setName() on the MetaDataEntityLocal The primary key passed will
348: * first be resolved to a MetaDataEntityBean on which the operation should
349: * be invoked on.
350: * @param pk - String representing the primary key of the MetaDataEntityBean
351: * to invoke the operation on
352: * @param name - String representing the name of the MetaDataEntityBean
353: * @exception NullPointerException - thrown if the primary key passed in is
354: * null
355: * @exception MediaException thrown if the exception was thrown by the
356: * MetaDataEntityLocal operation
357: * @exception NamingException thrown if there are problems looking up the
358: * MetaDataEntityLocalHome
359: * @exception FinderException thrown if the primary key can not be found in
360: * the datastore
361: */
362: public void setMetaDataEntityName(String pk, String name)
363: throws NamingException, FinderException, MediaException,
364: java.rmi.RemoteException;
365:
366: /**
367: * Invokes setPreviousVersion(MetaDataEntityLocal) on the
368: * MetaDataEntityLocal The primary key passed will first be resolved to a
369: * MetaDataEntityBean on which the operation should be invoked on. The
370: * primary key passed representing the MetaDataEntityBean's previous version
371: * MetaDataEntityBean will be located in the datastore and resolved to a
372: * MetaDataEntityLocal before it is passed into the setter. If the primary
373: * key representing the previous version is null then null will be passed
374: * in.
375: * @param pk - String representing the primary key of the MetaDataEntityBean
376: * to invoke the operation on
377: * @param pvpk - String representing the primary key of the
378: * MetaDataEntityBean's previous version or null
379: * @exception NullPointerException - thrown if the primary key passed in is
380: * null
381: * @exception MediaException thrown if the exception was thrown by the
382: * MetaDataEntityLocal operation
383: * @exception NamingException thrown if there are problems looking up the
384: * MetaDataEntityLocalHome
385: * @exception FinderException thrown if the primary key can not be found in
386: * the datastore
387: */
388: public void setMetaDataEntityPreviousVersion(String pk, String pvpk)
389: throws NamingException, FinderException, MediaException,
390: java.rmi.RemoteException;
391:
392: /**
393: * Invokes setXML(String, String, boolean) on the MetaDataEntityLocal The
394: * primary key passed will first be resolved to a MetaDataEntityBean on
395: * which the operation should be invoked on.
396: * @param pk - String representing the primary key of the MetaDataEntityBean
397: * to invoke the operation on
398: * @param xmlContent - String containing the xml metadata to set on the
399: * MetaDataEntityBean
400: * @param validate - boolean flag for enabling validation of the xml
401: * @exception NullPointerException - thrown if the primary key passed in is
402: * null
403: * @throws MediaException thrown if the exception was thrown by the
404: * MetaDataEntityLocal operation
405: * @throws NamingException thrown if there are problems looking up the
406: * MetaDataEntityLocalHome
407: * @throws FinderException thrown if either primary key can not be found in
408: * the datastore
409: */
410: public void setMetaDataEntityXML(String pk, String xmlContent,
411: boolean validate) throws MediaException, NamingException,
412: FinderException, java.rmi.RemoteException;
413:
414: /*
415: * MetaDataEntityLocalHome Wrapped Methods
416: */
417:
418: /**
419: * Invokes create() on MetaDataEntityLocalHome. Returns the Primary Key of
420: * the created MetaDataEntityLocal Throws any exceptions originating from
421: * the call to MetaDataEntityLocalHome
422: * @return String - primary key coresponding to the created
423: * MetaDataEntityBean
424: * @exception MediaException thrown if the exception was thrown by the
425: * MetaDataEntityLocalHome import operation
426: * @exception NamingException thrown if there are problems looking up the
427: * MetaDataEntityLocalHome
428: * @exception CreateException thrown if the exception was thrown by the
429: * MetaDataEntityLocalHome import operation
430: */
431: public String createMetaDataEntityBean() throws MediaException,
432: CreateException, NamingException, java.rmi.RemoteException;
433:
434: /**
435: * Invokes findByPrimaryKey(String) on MetaDataEntityLocalHome The primary
436: * key passed in and the primary key returned should be the same (or the
437: * operation has failed) however no validation checking is done by this
438: * method.
439: * @param pk - String representing primary key to find in the datastore
440: * @return String - primary key of the located MetaDataEntityBean
441: * @exception NamingException thrown if there are problems looking up the
442: * MetaDataEntityLocalHome
443: * @exception FinderException thrown if the primary key can not be found in
444: * the datastore
445: */
446: public String findMDEBByPrimaryKey(String pk)
447: throws NamingException, FinderException,
448: java.rmi.RemoteException;
449:
450: /**
451: * Invokes the query(String, String, String) on MetaDataEntityLocalHome An
452: * array of primary keys is built from the collection of located
453: * MetaDataEntityBeans and returned.
454: * @param query - String representing the partial description to search for
455: * @param queryLang - String representing the query language to use
456: * @param options - String representing the options for the query language
457: * @return String[] - array of primary keys of located MediaEntityBeans
458: * matching the partial description
459: * @throws MediaException thrown if the exception was thrown by the
460: * MetaDataEntityLocalHome operation
461: * @throws NamingException thrown if there are problems looking up the
462: * MediaEntityLocalHome
463: * @throws FinderException thrown if no MediaEntityBeans can be found by the
464: * partial description
465: */
466: public String[] queryMetaDataEntity(String query, String queryLang,
467: java.util.Map options) throws MediaException,
468: NamingException, FinderException, java.rmi.RemoteException;
469:
470: /**
471: * Invokes the retrieveSupportedQueryLanguages on MetaDataEntityLocalHome
472: * @throws MediaException thrown if the exception was thrown by the
473: * MetaDataEntityLocalHome operation
474: * @throws NamingException thrown if there are problems looking up the
475: * MediaEntityLocalHome
476: */
477: public String[] retrieveMetaDataEntitySupportedQueryLanguages()
478: throws MediaException, NamingException,
479: java.rmi.RemoteException;
480:
481: /**
482: * Invokes the retrieveSupportedOptions on MetaDataEntityLocalHome
483: * @throws MediaException thrown if the exception was thrown by the
484: * MetaDataEntityLocalHome operation
485: * @throws NamingException thrown if there are problems looking up the
486: * MediaEntityLocalHome
487: */
488: public String[] retrieveMetaDataEntitySupportedOptions(
489: String queryLang) throws MediaException, NamingException,
490: java.rmi.RemoteException;
491:
492: /**
493: * Invokes create() on MediaEntityLocalHome. Returns the Primary Key of the
494: * created MediaEntityLocal Throws any exceptions originating from the call
495: * to MediaEntityLocalHome
496: * @return String - primary key coresponding to the created MediaEntityBean
497: * @exception MediaException thrown if the exception was thrown by the
498: * MediaEntityLocalHome import operation
499: * @exception NamingException thrown if there are problems looking up the
500: * MediaEntityLocalHome
501: * @exception CreateException thrown if the exception was thrown by the
502: * MediaEntityLocalHome import operation
503: */
504: public String createMediaEntityBean() throws MediaException,
505: CreateException, NamingException, java.rmi.RemoteException;
506:
507: /*
508: * Invokes remove() for the entity indicated by the key
509: */
510: public void removeMetaDataEntity(String key)
511: throws RemoveException, NamingException,
512: java.rmi.RemoteException;
513: }
|