Package com.oracle.communications.brm.cc.modules

Interface NotesModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMNotesModule

public interface NotesModule
extends BaseModule

Method Summary

Modifier and Type	Method	Description
Notes	createNotes(Notes notes)	Creates a notes object in BRM.Uses the shared PCM Connection when invoked from a BRM transaction Creates an independent PCM connection when invoked independently
List<NotesInfo>	getAllNotes(String billUnitId, String starts, String ends)	Retrieves the list of notes (including the conversations) for a bill unit of an account.
List<Notes>	getAllNotesforItemId(String id)	Retrieves all the notes for the item Id
List<Notes>	getAllNotesforTransactionId(String transactionId)	Retrieves the list of notes (including the conversations) for payment associated with the passed transaction id
List<Notes>	getNotes(String id, String type, String accountId, int notesType)	Retrieves the Notes object associated with an account and type of notes
List<Notes>	getNotes(String id, String type, String accountId, int notesType, int notesSubType)	Retrieves the Notes object associated with an account and type of notes
List<Notes>	getNotesforAccount(String accountId)	Retrieves notes of given account
void	setBaseOps(BaseOps ops)
Notes	updateNotes(Notes notes)	Updates the existing notes object.

Methods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule

getBaseOps, getURIContext, getUserContext, setURIContext, setUserContext

Method Details

createNotes

Notes createNotes(Notes notes)
           throws ApplicationException

Creates a notes object in BRM.Uses the shared PCM Connection when invoked from a BRM transaction Creates an independent PCM connection when invoked independently

Parameters:

notes - Notes payload Object

Returns:

Throws:

ApplicationException

updateNotes

Notes updateNotes(Notes notes)
           throws ApplicationException

Updates the existing notes object. Adds follow up comments to an existing BRM notes conversation

Parameters:

notes - Notes payload object

Returns:

instance of Notes

Throws:

ApplicationException

getNotes

List<Notes> getNotes(String id,
 String type,
 String accountId,
 int notesType)
              throws ApplicationException

Retrieves the Notes object associated with an account and type of notes

Parameters:

id - Id of the object for which notes is created (ex: 0.0.0.1 -item-adjustment 73485)

type - Type of notes object ex:item,service,event,billInfo

accountId - Account Id for which notes is associated

notesType - fetch the notes of particular type

Returns:

List of Notes payload Object

Throws:

ApplicationException

getNotes

List<Notes> getNotes(String id,
 String type,
 String accountId,
 int notesType,
 int notesSubType)
              throws ApplicationException

Retrieves the Notes object associated with an account and type of notes

Parameters:

id - Id of the object for which notes is created (ex: 0.0.0.1 -item-adjustment 73485)

type - Type of notes object ex:item,service,event,billInfo

accountId - Account Id for which notes is associated

notesType - fetch the notes of particular type

notesSubType - fetch the notes of particular sub type

Returns:

List of Notes payload Object

Throws:

ApplicationException

getAllNotes

List<NotesInfo> getAllNotes(String billUnitId,
 String starts,
 String ends)
                     throws ApplicationException

Retrieves the list of notes (including the conversations) for a bill unit of an account.

Parameters:

billUnitId - (Bill Unit ID)

starts - (start date of notes, this parameter is optional)

ends - (end date of notes, this parameter is optional)

Returns:

notesInfoList on success, exception will be raised on error

Throws:

ApplicationException

getAllNotesforItemId

List<Notes> getAllNotesforItemId(String id)
                          throws ApplicationException

Retrieves all the notes for the item Id

Parameters:

id - (Item ID)

Returns:

List of notes on success, exception will be raised on error

Throws:

ApplicationException

getAllNotesforTransactionId

List<Notes> getAllNotesforTransactionId(String transactionId)
                                 throws ApplicationException

Retrieves the list of notes (including the conversations) for payment associated with the passed transaction id

Parameters:

transactionId - - transaction id of the payment ex: "T1,a,0"

Returns:

notesList on success, exception will be raised on error

Throws:

ApplicationException - (if there is no note associated, returns a dummy note object with payment id and account id associated with the given transaction id)

setBaseOps

void setBaseOps(BaseOps ops)

Specified by:

setBaseOps in interface BaseModule

Parameters:

ops -

getNotesforAccount

List<Notes> getNotesforAccount(String accountId)
                        throws ApplicationException

Retrieves notes of given account

Parameters:

accountId - (Account number)

Returns:

notes

Throws:

ApplicationException