001: package com.ibm.emb.meb.wrapper;
002:
003: import java.io.File;
004: import java.io.FileNotFoundException;
005: import java.net.URL;
006:
007: import javax.ejb.CreateException;
008: import javax.ejb.FinderException;
009: import javax.emb.Media;
010: import javax.emb.MediaConverterSpec;
011: import javax.emb.MediaException;
012: import javax.emb.MediaFormat;
013: import javax.emb.MediaHeader;
014: import javax.emb.MediaListener;
015: import javax.emb.ProtocolConstraints;
016: import javax.naming.NamingException;
017:
018: /**
019: * Remote interface for Enterprise Bean: MediaEntityWrapper
020: */
021: public interface MediaEntityWrapper extends javax.ejb.EJBObject {
022:
023: /*
024: * MediaEntityLocalHome Wrapped Methods
025: */
026:
027: /**
028: * Invokes create() on MediaEntityLocalHome. Returns the Primary Key of the
029: * created MediaEntityLocal Throws any exceptions originating from the call
030: * to MediaEntityLocalHome
031: * @return String - primary key coresponding to the created MediaEntityBean
032: * @exception MediaException thrown if the exception was thrown by the
033: * MediaEntityLocalHome import operation
034: * @exception NamingException thrown if there are problems looking up the
035: * MediaEntityLocalHome
036: * @exception CreateException thrown if the exception was thrown by the
037: * MediaEntityLocalHome import operation
038: */
039: public String createMediaEntityBean() throws MediaException,
040: CreateException, NamingException, java.rmi.RemoteException;
041:
042: /**
043: * Invokes create() on MetaDataEntityLocalHome. Returns the Primary Key of
044: * the created MetaDataEntityLocal Throws any exceptions originating from
045: * the call to MediaEntityLocalHome
046: * @return String - primary key coresponding to the created MediaEntityBean
047: * @exception MediaException thrown if the exception was thrown by the
048: * MediaEntityLocalHome import operation
049: * @exception NamingException thrown if there are problems looking up the
050: * MediaEntityLocalHome
051: * @exception CreateException thrown if the exception was thrown by the
052: * MediaEntityLocalHome import operation
053: */
054: public String createMetaDataEntityBean() throws MediaException,
055: CreateException, NamingException, java.rmi.RemoteException;
056:
057: /**
058: * Invokes importMedia(URL[],String[]) on MediaEntityLocalHome. Returns an
059: * array of Primary Keys matching the order of the returned
060: * MediaEntityLocals. If one of the MediaEntityLocal elements in the array
061: * returned from MediaEntityLocalHome is null, then coresponding null
062: * element in the Primary Key array will be returned. Throws any exceptions
063: * originating from the call to MediaEntityLocalHome
064: * @param urls - URL array of source URLs to import
065: * @param names - String array of names to use when importing the content
066: * @return String[] - array of primary keys coresponding to the created
067: * MediaEntityLocals returned from the importMedia operation on the
068: * home.
069: * @exception MediaException thrown if the exception was thrown by the
070: * MediaEntityLocalHome import operation
071: * @exception NamingException thrown if there are problems looking up the
072: * MediaEntityLocalHome
073: * @exception CreateException thrown if the exception was thrown by the
074: * MediaEntityLocalHome import operation
075: */
076: public String[] importHomeMediaEntityBeans(URL[] urls,
077: String[] names) throws MediaException, NamingException,
078: CreateException, java.rmi.RemoteException;
079:
080: /**
081: * Invokes exportMedia(MediaEntityLocal[], URL) on MediaEntityLocalHome. An
082: * array of MediaEntityLocals will be created from the array of primary keys
083: * passed in. If one of the elements in the primary key array is null, a
084: * coresponding null element will be placed in the created MediaEntityLocal
085: * array.
086: * @param pks - String array of primary keys representing the
087: * MediaEntityBeans to export
088: * @param targetDir - URL representing the targetDirectory to export the
089: * media to
090: * @return URL[] - array of URLs representing the exported file location of
091: * the MediaEntityBeans
092: * @exception MediaException thrown if the exception was thrown by the
093: * MediaEntityLocalHome import operation
094: * @exception NamingException thrown if there are problems looking up the
095: * MediaEntityLocalHome
096: * @exception FinderException thrown if an element in the primary key array
097: * can not be found in the datastore
098: */
099: public URL[] exportHomeMediaEntityBeans(String[] pks, URL targetDir)
100: throws MediaException, NamingException, FinderException,
101: java.rmi.RemoteException;
102:
103: /**
104: * Invokes findByPrimaryKey(String) on MediaEntityLocalHome The primary key
105: * passed in and the primary key returned should be the same (or the
106: * operation has failed) however no validation checking is done by this
107: * method.
108: * @param pk - String representing primary key to find in the datastore
109: * @return String - primary key of the located MediaEntityBean
110: * @exception NamingException thrown if there are problems looking up the
111: * MediaEntityLocalHome
112: * @exception FinderException thrown if the primary key can not be found in
113: * the datastore
114: */
115: public String findMEBByPrimaryKey(String pk)
116: throws NamingException, FinderException,
117: java.rmi.RemoteException;
118:
119: /**
120: * Invokes the findByPartialDescription(String) on MediaEntityLocalHome An
121: * array of primary keys is built from the collection of located
122: * MediaEntityBeans and returned.
123: * @param partialDesc - String representing the partial description to
124: * search for
125: * @return String[] - array of primary keys of located MediaEntityBeans
126: * matching the partial description
127: * @throws NamingException thrown if there are problems looking up the
128: * MediaEntityLocalHome
129: * @throws FinderException thrown if no MediaEntityBeans can be found by the
130: * partial description
131: */
132: public String[] findMEBByPartialDescription(String partialDesc)
133: throws NamingException, FinderException,
134: java.rmi.RemoteException;
135:
136: /**
137: * Invokes the findByPartialLocation(String) on MediaEntityLocalHome An
138: * array of primary keys is built from the collection of located
139: * MediaEntityBeans and returned.
140: * @param partialLoc - String representing the partial location to search
141: * for
142: * @return String[] - array of primary keys of located MediaEntityBeans
143: * matching the partial location
144: * @throws NamingException thrown if there are problems looking up the
145: * MediaEntityLocalHome
146: * @throws FinderException thrown if no MediaEntityBeans can be found by the
147: * partial location
148: */
149: public String[] findMEBByPartialLocation(String partialLoc)
150: throws NamingException, FinderException,
151: java.rmi.RemoteException;
152:
153: /**
154: * Invokes the publishContent(Media, String, ProtocalConstraints) on
155: * MediaEntityLocalHome The URL of the published media is returned.
156: * @param mediaobj - Media representing the transient or persistent media
157: * object to publish
158: * @param protocol - String representing the protocol to use when publishing
159: * @param constraints - ProtocalConstraints containing the constraints to
160: * publish with (if any)
161: * @return URL representing the location of the published media
162: * @throws MediaException thrown if the exception was thrown by the
163: * MediaEntityLocalHome import operation
164: * @throws NamingException thrown if there are problems looking up the
165: * MediaEntityLocalHome
166: */
167: public URL publishMediaContent(Media mediaobj, byte protocol,
168: ProtocolConstraints constraints) throws MediaException,
169: NamingException, java.rmi.RemoteException;
170:
171: /**
172: * Invokes the publishMedia(MediaEntityLocal[], String, ProtocalConstraints)
173: * on MediaEntityLocalHome The URL of the published media is returned. An
174: * array of MediaEntityLocals will be created from the array of primary keys
175: * passed in. If one of the elements in the primary key array is null, a
176: * coresponding null element will be placed in the created MediaEntityLocal
177: * array.
178: * @param pks - String array of primary keys representing the playlist of
179: * MediaEntityBeans to publish
180: * @param protocol - String representing the protocol to use when publishing
181: * @param constraints - ProtocalConstraints containing the constraints to
182: * publish with (if any)
183: * @return URL representing the location of the published media
184: * @throws MediaException thrown if the exception was thrown by the
185: * MediaEntityLocalHome import operation
186: * @throws NamingException thrown if there are problems looking up the
187: * MediaEntityLocalHome
188: * @exception FinderException thrown if an element in the primary key array
189: * can not be found in the datastore
190: */
191: public Media publishMediaEntityBeans(String[] pks, byte protocol,
192: ProtocolConstraints constraints) throws MediaException,
193: NamingException, FinderException, java.rmi.RemoteException;
194:
195: /*
196: * MediaEntityLocal Wrapped Methods
197: */
198:
199: /**
200: * Invokes addListener(MediaListener) on the MediaEntityLocal The primary
201: * key passed will first be resolved to a MediaEntityBean on which the
202: * operation should be invoked on.
203: * @param pk - String representing the primary key of the MediaEntityBean to
204: * invoke the operation on
205: * @param listener - MediaListener representing the listener to add to the
206: * MediaEntityBean
207: * @exception NullPointerException - thrown if the primary key passed in is
208: * null
209: * @exception MediaException thrown if the exception was thrown by the
210: * MediaEntityLocal operation
211: * @exception NamingException thrown if there are problems looking up the
212: * MediaEntityLocalHome
213: * @exception FinderException thrown if the primary key can not be found in
214: * the datastore
215: */
216: public void addMediaEntityListener(String pk, MediaListener listener)
217: throws MediaException, NamingException, FinderException,
218: java.rmi.RemoteException;
219:
220: /**
221: * Invokes addMetaData(MetaDataEntityLocal) on the MediaEntityLocal The MEB
222: * primary key passed will first be resolved to a MediaEntityBean on which
223: * the operation should be invoked on. If the MDEB primary key is not null,
224: * it will be resolved to a MetaDataEntityBean before it is passed in to the
225: * method. If the MDEB is null, null is passed in.
226: * @param mebpk - String representing the primary key of the MediaEntityBean
227: * to invoke the operation on
228: * @param mdebpk - String representing the primary key of the
229: * MetaDataEntityBean to pass into the operation
230: * @exception NullPointerException - thrown if the primary key passed in is
231: * null
232: * @exception MediaException thrown if the exception was thrown by the
233: * MediaEntityLocal operation
234: * @exception NamingException thrown if there are problems looking up the
235: * MediaEntityLocalHome or the MetaDataEntityLocalHome
236: * @exception FinderException thrown if either primary keys can not be found
237: * in the datastore
238: */
239: public void addMediaEntityMetaData(String mebpk, String mdebpk)
240: throws MediaException, NamingException, FinderException,
241: java.rmi.RemoteException;
242:
243: /**
244: * Invokes convert(MediaConverterSpec[]) on the MediaEntityLocal The primary
245: * key passed will first be resolved to a MediaEntityBean on which the
246: * operation should be invoked on.
247: * @param pk - String representing the primary key of the MediaEntityBean to
248: * invoke the operation on
249: * @param specs - MediaConverterSpec array of media converters defining the
250: * transformations to be done to the content.
251: * @exception NullPointerException - thrown if the primary key passed in is
252: * null
253: * @exception MediaException thrown if the exception was thrown by the
254: * MediaEntityLocal operation
255: * @exception NamingException thrown if there are problems looking up the
256: * MediaEntityLocalHome
257: * @exception FinderException thrown if the primary key can not be found in
258: * the datastore
259: */
260: public void convertMediaEntity(String pk, MediaConverterSpec[] specs)
261: throws NamingException, FinderException, MediaException,
262: java.rmi.RemoteException;
263:
264: /**
265: * Invokes exportMedia(URL) on the MediaEntityLocal The primary key passed
266: * will first be resolved to a MediaEntityBean on which the operation should
267: * be invoked on.
268: * @param pk - String representing the primary key of the MediaEntityBean to
269: * invoke the operation on
270: * @param loc - URL representing the targetlocation to export
271: * @return URL with the location of the exported Media
272: * @exception NullPointerException - thrown if the primary key passed in is
273: * null
274: * @exception MediaException thrown if the exception was thrown by the
275: * MediaEntityLocal operation
276: * @exception NamingException thrown if there are problems looking up the
277: * MediaEntityLocalHome
278: * @exception FinderException thrown if the primary key can not be found in
279: * the datastore
280: */
281: public URL exportMediaEntity(String pk, URL loc)
282: throws NamingException, FinderException, MediaException,
283: java.rmi.RemoteException;
284:
285: /**
286: * Invokes getChildren() on the MediaEntityLocal The primary key passed will
287: * first be resolved to a MediaEntityBean on which the operation should be
288: * invoked on. The array of MediaEntityBean children will first be converted
289: * into an array of primary keys representing the children before being
290: * returned.
291: * @param pk - String representing the primary key of the MediaEntityBean to
292: * invoke the operation on
293: * @return String array of primary keys representing the children on the
294: * MediaEntityBean
295: * @exception NullPointerException - thrown if the primary key passed in is
296: * null
297: * @exception MediaException thrown if the exception was thrown by the
298: * MediaEntityLocal operation
299: * @exception NamingException thrown if there are problems looking up the
300: * MediaEntityLocalHome
301: * @exception FinderException thrown if the primary key can not be found in
302: * the datastore
303: */
304: public String[] getMediaEntityChildren(String pk)
305: throws NamingException, FinderException, MediaException,
306: java.rmi.RemoteException;
307:
308: /**
309: * Invokes getContent() on the MediaEntityLocal The primary key passed will
310: * first be resolved to a MediaEntityBean on which the operation should be
311: * invoked on.
312: * @param pk - String representing the primary key of the MediaEntityBean to
313: * invoke the operation on
314: * @return byte array of the MediaEntityBean's content
315: * @exception NullPointerException - thrown if the primary key passed in is
316: * null
317: * @exception MediaException thrown if the exception was thrown by the
318: * MediaEntityLocal operation
319: * @exception NamingException thrown if there are problems looking up the
320: * MediaEntityLocalHome
321: * @exception FinderException thrown if the primary key can not be found in
322: * the datastore
323: */
324: public byte[] getMediaEntityContent(String pk)
325: throws NamingException, FinderException, MediaException,
326: java.rmi.RemoteException;
327:
328: /**
329: * Invokes getDescription() on the MediaEntityLocal The primary key passed
330: * will first be resolved to a MediaEntityBean on which the operation should
331: * be invoked on.
332: * @param pk - String representing the primary key of the MediaEntityBean to
333: * invoke the operation on
334: * @return String representing the description of the MediaEntityBean's
335: * content
336: * @exception NullPointerException - thrown if the primary key passed in is
337: * null
338: * @exception MediaException thrown if the exception was thrown by the
339: * MediaEntityLocal operation
340: * @exception NamingException thrown if there are problems looking up the
341: * MediaEntityLocalHome
342: * @exception FinderException thrown if the primary key can not be found in
343: * the datastore
344: */
345: public String getMediaEntityDescription(String pk)
346: throws NamingException, FinderException, MediaException,
347: java.rmi.RemoteException;
348:
349: /**
350: * Invokes getFormat() on the MediaEntityLocal The primary key passed will
351: * first be resolved to a MediaEntityBean on which the operation should be
352: * invoked on.
353: * @param pk - String representing the primary key of the MediaEntityBean to
354: * invoke the operation on
355: * @return MediaFormat representing the MediaEntityBean's format
356: * @exception NullPointerException - thrown if the primary key passed in is
357: * null
358: * @exception MediaException thrown if the exception was thrown by the
359: * MediaEntityLocal operation
360: * @exception NamingException thrown if there are problems looking up the
361: * MediaEntityLocalHome
362: * @exception FinderException thrown if the primary key can not be found in
363: * the datastore
364: */
365: public MediaFormat getMediaEntityFormat(String pk)
366: throws NamingException, FinderException, MediaException,
367: java.rmi.RemoteException;
368:
369: /**
370: * Invokes getHeader() on the MediaEntityLocal The primary key passed will
371: * first be resolved to a MediaEntityBean on which the operation should be
372: * invoked on.
373: * @param pk - String representing the primary key of the MediaEntityBean to
374: * invoke the operation on
375: * @return MediaHeader representing the MediaEntityBean's header
376: * @exception NullPointerException - thrown if the primary key passed in is
377: * null
378: * @exception MediaException thrown if the exception was thrown by the
379: * MediaEntityLocal operation
380: * @exception NamingException thrown if there are problems looking up the
381: * MediaEntityLocalHome
382: * @exception FinderException thrown if the primary key can not be found in
383: * the datastore
384: */
385: public MediaHeader getMediaEntityHeader(String pk)
386: throws NamingException, FinderException, MediaException,
387: java.rmi.RemoteException;
388:
389: /**
390: * Invokes getLastModified() on the MediaEntityLocal The primary key passed
391: * will first be resolved to a MediaEntityBean on which the operation should
392: * be invoked on.
393: * @param pk - String representing the primary key of the MediaEntityBean to
394: * invoke the operation on
395: * @return long representing the timestamp of when MediaEntityBean was last
396: * modified
397: * @exception NullPointerException - thrown if the primary key passed in is
398: * null
399: * @exception MediaException thrown if the exception was thrown by the
400: * MediaEntityLocal operation
401: * @exception NamingException thrown if there are problems looking up the
402: * MediaEntityLocalHome
403: * @exception FinderException thrown if the primary key can not be found in
404: * the datastore
405: */
406: public long getMediaEntityLastModified(String pk)
407: throws NamingException, FinderException, MediaException,
408: java.rmi.RemoteException;
409:
410: /**
411: * Invokes getListeners() on the MediaEntityLocal The primary key passed
412: * will first be resolved to a MediaEntityBean on which the operation should
413: * be invoked on.
414: * @param pk - String representing the primary key of the MediaEntityBean to
415: * invoke the operation on
416: * @return MediaEntityListener array of the MediaEntityBean listeners
417: * @exception NullPointerException - thrown if the primary key passed in is
418: * null
419: * @exception MediaException thrown if the exception was thrown by the
420: * MediaEntityLocal operation
421: * @exception NamingException thrown if there are problems looking up the
422: * MediaEntityLocalHome
423: * @exception FinderException thrown if the primary key can not be found in
424: * the datastore
425: */
426: public MediaListener[] getMediaEntityListeners(String pk)
427: throws NamingException, FinderException, MediaException,
428: java.rmi.RemoteException;
429:
430: /**
431: * Invokes getLocation() on the MediaEntityLocal The primary key passed will
432: * first be resolved to a MediaEntityBean on which the operation should be
433: * invoked on.
434: * @param pk - String representing the primary key of the MediaEntityBean to
435: * invoke the operation on
436: * @return URL representing the location of the MediaEntityBean
437: * @exception NullPointerException - thrown if the primary key passed in is
438: * null
439: * @exception MediaException thrown if the exception was thrown by the
440: * MediaEntityLocal operation
441: * @exception NamingException thrown if there are problems looking up the
442: * MediaEntityLocalHome
443: * @exception FinderException thrown if the primary key can not be found in
444: * the datastore
445: */
446: public URL getMediaEntityLocation(String pk)
447: throws NamingException, FinderException, MediaException,
448: java.rmi.RemoteException;
449:
450: /**
451: * Invokes getMetaData() on the MediaEntityLocal The primary key passed will
452: * first be resolved to a MediaEntityBean on which the operation should be
453: * invoked on. The array of MetaDataEntityBean metadata will first be
454: * converted into an array of primary keys representing the metadata before
455: * being returned.
456: * @param pk - String representing the primary key of the MediaEntityBean to
457: * invoke the operation on
458: * @return String array of primary keys representing the MetaDataEntityBean
459: * metadata on the MediaEntityBean
460: * @exception NullPointerException - thrown if the primary key passed in is
461: * null
462: * @exception MediaException thrown if the exception was thrown by the
463: * MediaEntityLocal operation
464: * @exception NamingException thrown if there are problems looking up the
465: * MediaEntityLocalHome or MetaDataEntityLocalHome
466: * @exception FinderException thrown if the primary key can not be found in
467: * the datastore
468: */
469: public String[] getMediaEntityMetaData(String pk)
470: throws NamingException, FinderException, MediaException,
471: java.rmi.RemoteException;
472:
473: /**
474: * Invokes getMimeType() on the MediaEntityLocal The primary key passed will
475: * first be resolved to a MediaEntityBean on which the operation should be
476: * invoked on.
477: * @param pk - String representing the primary key of the MediaEntityBean to
478: * invoke the operation on
479: * @return String representing the mimetype of the MediaEntityBean
480: * @exception NullPointerException - thrown if the primary key passed in is
481: * null
482: * @exception MediaException thrown if the exception was thrown by the
483: * MediaEntityLocal operation
484: * @exception NamingException thrown if there are problems looking up the
485: * MediaEntityLocalHome
486: * @exception FinderException thrown if the primary key can not be found in
487: * the datastore
488: */
489: public String getMediaEntityMimeType(String pk)
490: throws NamingException, FinderException, MediaException,
491: java.rmi.RemoteException;
492:
493: /**
494: * Invokes getName() on the MediaEntityLocal The primary key passed will
495: * first be resolved to a MediaEntityBean on which the operation should be
496: * invoked on.
497: * @param pk - String representing the primary key of the MediaEntityBean to
498: * invoke the operation on
499: * @return String representing the name of the MediaEntityBean
500: * @exception NullPointerException - thrown if the primary key passed in is
501: * null
502: * @exception MediaException thrown if the exception was thrown by the
503: * MediaEntityLocal operation
504: * @exception NamingException thrown if there are problems looking up the
505: * MediaEntityLocalHome
506: * @exception FinderException thrown if the primary key can not be found in
507: * the datastore
508: */
509: public String getMediaEntityName(String pk) throws NamingException,
510: FinderException, MediaException, java.rmi.RemoteException;
511:
512: /**
513: * Invokes getNextVersion() on the MediaEntityLocal The primary key passed
514: * will first be resolved to a MediaEntityBean on which the operation should
515: * be invoked on. The primary key of the MediaEntityBean's next version
516: * MediaEntityBean will be returned or null if the next version is null.
517: * @param pk - String representing the primary key of the MediaEntityBean to
518: * invoke the operation on
519: * @return String representing the primary key of the MediaEntityBean's next
520: * version or null
521: * @exception NullPointerException - thrown if the primary key passed in is
522: * null
523: * @exception MediaException thrown if the exception was thrown by the
524: * MediaEntityLocal operation
525: * @exception NamingException thrown if there are problems looking up the
526: * MediaEntityLocalHome
527: * @exception FinderException thrown if the primary key can not be found in
528: * the datastore
529: */
530: public String getMediaEntityNextVersion(String pk)
531: throws NamingException, FinderException, MediaException,
532: java.rmi.RemoteException;
533:
534: /**
535: * Invokes getParents() on the MediaEntityLocal The primary key passed will
536: * first be resolved to a MediaEntityBean on which the operation should be
537: * invoked on. The array of MediaEntityBean parents will first be converted
538: * into an array of primary keys representing the parents before being
539: * returned.
540: * @param pk - String representing the primary key of the MediaEntityBean to
541: * invoke the operation on
542: * @return String array of primary keys representing the parents on the
543: * MediaEntityBean
544: * @exception NullPointerException - thrown if the primary key passed in is
545: * null
546: * @exception MediaException thrown if the exception was thrown by the
547: * MediaEntityLocal operation
548: * @exception NamingException thrown if there are problems looking up the
549: * MediaEntityLocalHome
550: * @exception FinderException thrown if the primary key can not be found in
551: * the datastore
552: */
553: public String[] getMediaEntityParents(String pk)
554: throws NamingException, FinderException, MediaException,
555: java.rmi.RemoteException;
556:
557: /**
558: * Invokes getPreviousVersion() on the MediaEntityLocal The primary key
559: * passed will first be resolved to a MediaEntityBean on which the operation
560: * should be invoked on. The primary key of the MediaEntityBean's previous
561: * version MediaEntityBean will be returned or null if the next version is
562: * null.
563: * @param pk - String representing the primary key of the MediaEntityBean to
564: * invoke the operation on
565: * @return String representing the primary key of the MediaEntityBean's
566: * previous version or null
567: * @exception NullPointerException - thrown if the primary key passed in is
568: * null
569: * @exception MediaException thrown if the exception was thrown by the
570: * MediaEntityLocal operation
571: * @exception NamingException thrown if there are problems looking up the
572: * MediaEntityLocalHome
573: * @exception FinderException thrown if the primary key can not be found in
574: * the datastore
575: */
576: public String getMediaEntityPreviousVersion(String pk)
577: throws NamingException, FinderException, MediaException,
578: java.rmi.RemoteException;
579:
580: /**
581: * Invokes getProxy() on the MediaEntityLocal The primary key passed will
582: * first be resolved to a MediaEntityBean on which the operation should be
583: * invoked on.
584: * @param pk - String representing the primary key of the MediaEntityBean to
585: * invoke the operation on
586: * @return Media object representing the proxy of the MediaEntityBean
587: * @exception NullPointerException - thrown if the primary key passed in is
588: * null
589: * @exception MediaException thrown if the exception was thrown by the
590: * MediaEntityLocal operation
591: * @exception NamingException thrown if there are problems looking up the
592: * MediaEntityLocalHome
593: * @exception FinderException thrown if the primary key can not be found in
594: * the datastore
595: */
596: public Media getMediaEntityProxy(String pk) throws NamingException,
597: FinderException, MediaException, java.rmi.RemoteException;
598:
599: /**
600: * Invokes getSize() on the MediaEntityLocal The primary key passed will
601: * first be resolved to a MediaEntityBean on which the operation should be
602: * invoked on.
603: * @param pk - String representing the primary key of the MediaEntityBean to
604: * invoke the operation on
605: * @return long size of the MediaEntityBean's content
606: * @exception NullPointerException - thrown if the primary key passed in is
607: * null
608: * @exception MediaException thrown if the exception was thrown by the
609: * MediaEntityLocal operation
610: * @exception NamingException thrown if there are problems looking up the
611: * MediaEntityLocalHome
612: * @exception FinderException thrown if the primary key can not be found in
613: * the datastore
614: */
615: public long getMediaEntitySize(String pk) throws NamingException,
616: FinderException, MediaException, java.rmi.RemoteException;
617:
618: /**
619: * Invokes importMedia(URL, String) on the MediaEntityLocal The primary key
620: * passed will first be resolved to a MediaEntityBean on which the operation
621: * should be invoked on.
622: * @param pk - String representing the primary key of the MediaEntityBean to
623: * invoke the operation on
624: * @param loc - URL representing the location of the source file to import
625: * content from
626: * @param name - String representing the optional name to be set on the
627: * MediaEntityBean during the import
628: * @exception NullPointerException - thrown if the primary key passed in is
629: * null
630: * @exception MediaException thrown if the exception was thrown by the
631: * MediaEntityLocal operation
632: * @exception NamingException thrown if there are problems looking up the
633: * MediaEntityLocalHome
634: * @exception FinderException thrown if the primary key can not be found in
635: * the datastore
636: */
637: public void importMediaEntityContent(String pk, URL loc, String name)
638: throws NamingException, FinderException, MediaException,
639: CreateException, java.rmi.RemoteException;
640:
641: /**
642: * Invokes readContent(long, byte[]) on the MediaEntityLocal The primary key
643: * passed will first be resolved to a MediaEntityBean on which the operation
644: * should be invoked on.
645: * @param pk - String representing the primary key of the MediaEntityBean to
646: * invoke the operation on
647: * @param pos - long represeting the position to begin reading the content
648: * from
649: * @param buffer - byte array buffer to copy the media content into
650: * beginning at offset 0
651: * @return int representing the number of bytes read into the buffer
652: * @exception NullPointerException - thrown if the primary key passed in is
653: * null
654: * @exception MediaException thrown if the exception was thrown by the
655: * MediaEntityLocal operation
656: * @exception NamingException thrown if there are problems looking up the
657: * MediaEntityLocalHome
658: * @exception FinderException thrown if the primary key can not be found in
659: * the datastore
660: */
661: public int readMediaEntityContent(String pk, long pos, byte[] buffer)
662: throws NamingException, FinderException, MediaException,
663: java.rmi.RemoteException;
664:
665: /**
666: * Invokes readContent(long, byte[], int, int) on the MediaEntityLocal The
667: * primary key passed will first be resolved to a MediaEntityBean on which
668: * the operation should be invoked on.
669: * @param pk - String representing the primary key of the MediaEntityBean to
670: * invoke the operation on
671: * @param pos - long represeting the position to begin reading the content
672: * from
673: * @param buffer - byte array buffer to copy the media content into
674: * beginning at specified offset
675: * @param offset - int representing the offset in the buffer to begin
676: * copying the media content from
677: * @param length - int representing the max
678: * @return int representing the number of bytes read into the buffer
679: * @exception NullPointerException - thrown if the primary key passed in is
680: * null
681: * @exception MediaException thrown if the exception was thrown by the
682: * MediaEntityLocal operation
683: * @exception NamingException thrown if there are problems looking up the
684: * MediaEntityLocalHome
685: * @exception FinderException thrown if the primary key can not be found in
686: * the datastore
687: */
688: public int readMediaEntityContent(String pk, long pos,
689: byte[] buffer, int offset, int length)
690: throws NamingException, FinderException, MediaException,
691: java.rmi.RemoteException;
692:
693: /**
694: * Invokes removeListener(MediaListener) on the MediaEntityLocal The primary
695: * key passed will first be resolved to a MediaEntityBean on which the
696: * operation should be invoked on.
697: * @param pk - String representing the primary key of the MediaEntityBean to
698: * invoke the operation on
699: * @param listener - MediaListener representing the listener to remove from
700: * the MediaEntityBean
701: * @exception NullPointerException - thrown if the primary key passed in is
702: * null
703: * @exception MediaException thrown if the exception was thrown by the
704: * MediaEntityLocal operation
705: * @exception NamingException thrown if there are problems looking up the
706: * MediaEntityLocalHome
707: * @exception FinderException thrown if the primary key can not be found in
708: * the datastore
709: */
710: public void removeMediaEntityListener(String pk,
711: MediaListener listener) throws MediaException,
712: NamingException, FinderException, java.rmi.RemoteException;
713:
714: /**
715: * Invokes removeMetaData(MetaDataEntityLocal) on the MediaEntityLocal The
716: * MEB primary key passed will first be resolved to a MediaEntityBean on
717: * which the operation should be invoked on. If the MDEB primary key is not
718: * null, it will be resolved to a MetaDataEntityBean before it is passed in
719: * to the method. If the MDEB primary key is null, null is passed into the
720: * remove operation.
721: * @param mebpk - String representing the primary key of the MediaEntityBean
722: * to invoke the operation on
723: * @param mdebpk - String representing the primary key of the
724: * MetaDataEntityBean to remove
725: * @exception NullPointerException - thrown if the primary key passed in is
726: * null
727: * @exception MediaException thrown if the exception was thrown by the
728: * MediaEntityLocal operation
729: * @exception NamingException thrown if there are problems looking up the
730: * MediaEntityLocalHome or the MetaDataEntityLocalHome
731: * @exception FinderException thrown if either primary keys can not be found
732: * in the datastore
733: */
734: public void removeMediaEntityMetaData(String mebpk, String mdebpk)
735: throws MediaException, NamingException, FinderException,
736: java.rmi.RemoteException;
737:
738: /**
739: * Invokes setChildren() on the MediaEntityLocal The primary key passed will
740: * first be resolved to a MediaEntityBean on which the operation should be
741: * invoked on. The array of MediaEntityBean primary keys representing the
742: * children to be set will first be found in the datastore and converted to
743: * an array of MediaEntityLocals before being passed in. If an element of
744: * the primary key array is null, a coresponding null entry in the
745: * MediaEntityLocal array will be set.
746: * @param pk - String representing the primary key of the MediaEntityBean to
747: * invoke the operation on
748: * @return String array of primary keys representing the children to be set
749: * on the MediaEntityBean
750: * @exception NullPointerException - thrown if the primary key passed in is
751: * null
752: * @exception MediaException thrown if the exception was thrown by the
753: * MediaEntityLocal operation
754: * @exception NamingException thrown if there are problems looking up the
755: * MediaEntityLocalHome
756: * @exception FinderException thrown if any of the primary keys can not be
757: * found in the datastore
758: */
759: public void setMediaEntityChildren(String pk, String[] childpks)
760: throws NamingException, FinderException, MediaException,
761: java.rmi.RemoteException;
762:
763: /**
764: * Invokes setContent(byte[]) on the MediaEntityLocal The primary key passed
765: * will first be resolved to a MediaEntityBean on which the operation should
766: * be invoked on.
767: * @param pk - String representing the primary key of the MediaEntityBean to
768: * invoke the operation on
769: * @param content - byte array of content to be set on the MediaEntityBean
770: * @exception NullPointerException - thrown if the primary key passed in is
771: * null
772: * @exception MediaException thrown if the exception was thrown by the
773: * MediaEntityLocal operation
774: * @exception NamingException thrown if there are problems looking up the
775: * MediaEntityLocalHome
776: * @exception FinderException thrown if the primary key can not be found in
777: * the datastore
778: */
779: public void setMediaEntityContent(String pk, byte[] content)
780: throws NamingException, FinderException, MediaException,
781: java.rmi.RemoteException;
782:
783: /**
784: * Invokes setContent(InputStream) on the MediaEntityLocal The primary key
785: * passed will first be resolved to a MediaEntityBean on which the operation
786: * should be invoked on. Since an InputStream can not be passed over remote
787: * boundaries, a File which represents the path to the content is passed and
788: * is used to create a FileInputStream used to set the content.
789: * @param pk - String representing the primary key of the MediaEntityBean to
790: * invoke the operation on
791: * @param content - File that contains the content to be set on the
792: * MediaEntityBean
793: * @exception NullPointerException - thrown if the primary key passed in is
794: * null
795: * @exception MediaException thrown if the exception was thrown by the
796: * MediaEntityLocal operation
797: * @exception NamingException thrown if there are problems looking up the
798: * MediaEntityLocalHome
799: * @exception FinderException thrown if the primary key can not be found in
800: * the datastore
801: * @exception FileNotFoundException thrown if the File can not be located on
802: * the filesystem
803: */
804: public void setMediaEntityContent(String pk, File content)
805: throws NamingException, FinderException, MediaException,
806: FileNotFoundException, java.rmi.RemoteException;
807:
808: /**
809: * Invokes setDescription(String) on the MediaEntityLocal The primary key
810: * passed will first be resolved to a MediaEntityBean on which the operation
811: * should be invoked on.
812: * @param pk - String representing the primary key of the MediaEntityBean to
813: * invoke the operation on
814: * @param desc - String representing the description of the
815: * MediaEntityBean's content or null
816: * @exception NullPointerException - thrown if the primary key passed in is
817: * null
818: * @exception MediaException thrown if the exception was thrown by the
819: * MediaEntityLocal operation
820: * @exception NamingException thrown if there are problems looking up the
821: * MediaEntityLocalHome
822: * @exception FinderException thrown if the primary key can not be found in
823: * the datastore
824: */
825: public void setMediaEntityDescription(String pk, String desc)
826: throws NamingException, FinderException, MediaException,
827: java.rmi.RemoteException;
828:
829: /**
830: * Invokes setLocation(URL) on the MediaEntityLocal The primary key passed
831: * will first be resolved to a MediaEntityBean on which the operation should
832: * be invoked on.
833: * @param pk - String representing the primary key of the MediaEntityBean to
834: * invoke the operation on
835: * @param loc - URL representing the external location of the
836: * MediaEntityBean content or null
837: * @exception NullPointerException - thrown if the primary key passed in is
838: * null
839: * @exception MediaException thrown if the exception was thrown by the
840: * MediaEntityLocal operation
841: * @exception NamingException thrown if there are problems looking up the
842: * MediaEntityLocalHome
843: * @exception FinderException thrown if the primary key can not be found in
844: * the datastore
845: */
846: public void setMediaEntityLocation(String pk, URL loc)
847: throws NamingException, FinderException, MediaException,
848: java.rmi.RemoteException;
849:
850: /**
851: * Invokes setMimeType(String) on the MediaEntityLocal The primary key
852: * passed will first be resolved to a MediaEntityBean on which the operation
853: * should be invoked on.
854: * @param pk - String representing the primary key of the MediaEntityBean to
855: * invoke the operation on
856: * @param mimeType - String representing the mimetype of the MediaEntityBean
857: * @exception NullPointerException - thrown if the primary key passed in is
858: * null
859: * @exception MediaException thrown if the exception was thrown by the
860: * MediaEntityLocal operation
861: * @exception NamingException thrown if there are problems looking up the
862: * MediaEntityLocalHome
863: * @exception FinderException thrown if the primary key can not be found in
864: * the datastore
865: */
866: public void setMediaEntityMimeType(String pk, String mimeType)
867: throws NamingException, FinderException, MediaException,
868: java.rmi.RemoteException;
869:
870: /**
871: * Invokes setName() on the MediaEntityLocal The primary key passed will
872: * first be resolved to a MediaEntityBean on which the operation should be
873: * invoked on.
874: * @param pk - String representing the primary key of the MediaEntityBean to
875: * invoke the operation on
876: * @param name - String representing the name of the MediaEntityBean
877: * @exception NullPointerException - thrown if the primary key passed in is
878: * null
879: * @exception MediaException thrown if the exception was thrown by the
880: * MediaEntityLocal operation
881: * @exception NamingException thrown if there are problems looking up the
882: * MediaEntityLocalHome
883: * @exception FinderException thrown if the primary key can not be found in
884: * the datastore
885: */
886: public void setMediaEntityName(String pk, String name)
887: throws NamingException, FinderException, MediaException,
888: java.rmi.RemoteException;
889:
890: /**
891: * Invokes setPreviousVersion(MediaEntityLocal) on the MediaEntityLocal The
892: * primary key passed will first be resolved to a MediaEntityBean on which
893: * the operation should be invoked on. The primary key passed representing
894: * the MediaEntityBean's previous version MediaEntityBean will be located in
895: * the datastore and resolved to a MediaEntityLocal before it is passed into
896: * the setter. If the primary key representing the previous version is null
897: * then null will be passed in.
898: * @param pk - String representing the primary key of the MediaEntityBean to
899: * invoke the operation on
900: * @param pvpk - String representing the primary key of the
901: * MediaEntityBean's previous version or null
902: * @exception NullPointerException - thrown if the primary key passed in is
903: * null
904: * @exception MediaException thrown if the exception was thrown by the
905: * MediaEntityLocal operation
906: * @exception NamingException thrown if there are problems looking up the
907: * MediaEntityLocalHome
908: * @exception FinderException thrown if the primary key can not be found in
909: * the datastore
910: */
911: public void setMediaEntityPreviousVersion(String pk, String pvpk)
912: throws NamingException, FinderException, MediaException,
913: java.rmi.RemoteException;
914:
915: /**
916: * Invokes setProxy(MediaEntityLocal) on the MediaEntityLocal The primary
917: * key passed will first be resolved to a MediaEntityBean on which the
918: * operation should be invoked on. The primary key passed representing the
919: * MediaEntityBean's proxy MediaEntityBean will be located in the datastore
920: * and resolved to a MediaEntityLocal before it is passed into the setter.
921: * If the primary key representing the proxy is null then null will be
922: * passed in.
923: * @param pk - String representing the primary key of the MediaEntityBean to
924: * invoke the operation on
925: * @param proxypk - String representing the primary key of the proxy
926: * MediaEntityBean
927: * @exception NullPointerException - thrown if the primary key passed in is
928: * null
929: * @exception MediaException thrown if the exception was thrown by the
930: * MediaEntityLocal operation
931: * @exception NamingException thrown if there are problems looking up the
932: * MediaEntityLocalHome
933: * @exception FinderException thrown if the primary key can not be found in
934: * the datastore
935: */
936: public void setMediaEntityProxy(String pk, String proxypk)
937: throws NamingException, FinderException, MediaException,
938: java.rmi.RemoteException;
939: }
|